Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conformace with style guide #40

Closed
ivanperez-keera opened this issue Mar 6, 2023 · 0 comments
Closed

Conformace with style guide #40

ivanperez-keera opened this issue Mar 6, 2023 · 0 comments
Assignees
Labels
Milestone

Comments

@ivanperez-keera
Copy link
Owner

ivanperez-keera commented Mar 6, 2023

Description

Several files are not conformant with our own style guide.

A quick search shows the following potential violations:

3 File structure, no blank lines at top
./src/Animate.hs
./src/ColorBindings.hs
./src/Colors.hs
./src/Command.hs
./src/Diagnostics.hs
./src/IdentityList.hs
./src/Main.hs
./src/ObjectBehavior.hs
./src/Object.hs
./src/Parser.hs
./src/PhysicalDimensions.hs
./src/RenderLandscape.hs
./src/RenderObject.hs
./src/WorldGeometry.hs

3.3 All Haskell files must include a copyright notice in a comment
src/Animate.hs
src/ColorBindings.hs
src/Colors.hs
src/Command.hs
src/Diagnostics.hs
src/IdentityList.hs
src/Main.hs
src/ObjectBehavior.hs
src/Object.hs
src/Parser.hs
src/PhysicalDimensions.hs
src/RenderLandscape.hs
src/RenderObject.hs
src/WorldGeometry.hs

4.3 The column limit for Haskell files is 80 characters
src/Main.hs
src/Animate.hs

4.5.4.2 No trailing spaces
src/RenderObject.hs
src/WorldGeometry.hs
src/Parser.hs
src/Colors.hs
src/Object.hs

4.7 Comments must always be line comments
./src/RenderObject.hs
./src/WorldGeometry.hs
./src/ColorBindings.hs
./src/PhysicalDimensions.hs
./src/Parser.hs
./src/Colors.hs
./src/ObjectBehavior.hs
./src/Main.hs
./src/Command.hs
./src/IdentityList.hs
./src/Animate.hs
./src/Diagnostics.hs
./src/Object.hs
./src/RenderLandscape.hs

ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All Haskell files must include a copyright notice in a comment. The
copyright notice must be included in a format parseable by Haddock.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All Haskell files must include a copyright notice in a comment. The
copyright notice must be included in a format parseable by Haddock.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All Haskell files must include a copyright notice in a comment. The
copyright notice must be included in a format parseable by Haddock.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All Haskell files must include a copyright notice in a comment. The
copyright notice must be included in a format parseable by Haddock.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All Haskell files must include a copyright notice in a comment. The
copyright notice must be included in a format parseable by Haddock.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All Haskell files must include a copyright notice in a comment. The
copyright notice must be included in a format parseable by Haddock.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All Haskell files must include a copyright notice in a comment. The
copyright notice must be included in a format parseable by Haddock.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All Haskell files must include a copyright notice in a comment. The
copyright notice must be included in a format parseable by Haddock.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All Haskell files must include a copyright notice in a comment. The
copyright notice must be included in a format parseable by Haddock.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All Haskell files must include a copyright notice in a comment. The
copyright notice must be included in a format parseable by Haddock.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All Haskell files must include a copyright notice in a comment. The
copyright notice must be included in a format parseable by Haddock.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All Haskell files must include a copyright notice in a comment. The
copyright notice must be included in a format parseable by Haddock.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All Haskell files must include a copyright notice in a comment. The
copyright notice must be included in a format parseable by Haddock.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
No blank lines separate pragmas, the module haddock declaration, and the
module declaration.

This commit removes a comment that is not part of the haddock
declaration to after the imports.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
We set the code limit for Haskell files at 80 characters.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
We set the code limit for Haskell files at 80 characters.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
We set the code limit for Haskell files at 80 characters.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports should be grouped between external imports, external imports
from the same project (but different libraries) and internal imports.
When groups are used, comments must be used to indicate the nature of
each group. If there are no distinct groups, they are considered to be
all in the same group.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports should be grouped between external imports, external imports
from the same project (but different libraries) and internal imports.
When groups are used, comments must be used to indicate the nature of
each group. If there are no distinct groups, they are considered to be
all in the same group.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports should be grouped between external imports, external imports
from the same project (but different libraries) and internal imports.
When groups are used, comments must be used to indicate the nature of
each group. If there are no distinct groups, they are considered to be
all in the same group.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports should be grouped between external imports, external imports
from the same project (but different libraries) and internal imports.
When groups are used, comments must be used to indicate the nature of
each group. If there are no distinct groups, they are considered to be
all in the same group.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports should be grouped between external imports, external imports
from the same project (but different libraries) and internal imports.
When groups are used, comments must be used to indicate the nature of
each group. If there are no distinct groups, they are considered to be
all in the same group.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports should be grouped between external imports, external imports
from the same project (but different libraries) and internal imports.
When groups are used, comments must be used to indicate the nature of
each group. If there are no distinct groups, they are considered to be
all in the same group.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports should be grouped between external imports, external imports
from the same project (but different libraries) and internal imports.
When groups are used, comments must be used to indicate the nature of
each group. If there are no distinct groups, they are considered to be
all in the same group.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports should be grouped between external imports, external imports
from the same project (but different libraries) and internal imports.
When groups are used, comments must be used to indicate the nature of
each group. If there are no distinct groups, they are considered to be
all in the same group.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports should be grouped between external imports, external imports
from the same project (but different libraries) and internal imports.
When groups are used, comments must be used to indicate the nature of
each group. If there are no distinct groups, they are considered to be
all in the same group.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports should be grouped between external imports, external imports
from the same project (but different libraries) and internal imports.
When groups are used, comments must be used to indicate the nature of
each group. If there are no distinct groups, they are considered to be
all in the same group.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports should be grouped between external imports, external imports
from the same project (but different libraries) and internal imports.
When groups are used, comments must be used to indicate the nature of
each group. If there are no distinct groups, they are considered to be
all in the same group.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports should be grouped between external imports, external imports
from the same project (but different libraries) and internal imports.
When groups are used, comments must be used to indicate the nature of
each group. If there are no distinct groups, they are considered to be
all in the same group.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports belonging to the same group should be listed in alphabetical
order.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports belonging to the same group should be listed in alphabetical
order.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports belonging to the same group should be listed in alphabetical
order.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports belonging to the same group should be listed in alphabetical
order.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Imports belonging to the same group should be listed in alphabetical
order.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Elements imported from a module should be listed in alphabetical order.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Elements imported from a module should be listed in alphabetical order.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All top-level functions must include a type signature.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All top-level functions must include a type signature.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
All top-level functions must include a type signature.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Do not leave any spaces at the end of any line.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Do not leave any spaces at the end of any line.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Do not leave any spaces at the end of any line.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Horizontal alignment is required for the module names and lists of
imported symbols in contiguous import declarations (that is, those
beloging to the same group or those without empty lines separating
them).
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Horizontal alignment is required for the module names and lists of
imported symbols in contiguous import declarations (that is, those
beloging to the same group or those without empty lines separating
them).
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Horizontal alignment is required for the module names and lists of
imported symbols in contiguous import declarations (that is, those
beloging to the same group or those without empty lines separating
them).
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Horizontal alignment is required for the module names and lists of
imported symbols in contiguous import declarations (that is, those
beloging to the same group or those without empty lines separating
them).
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Horizontal alignment is required for the module names and lists of
imported symbols in contiguous import declarations (that is, those
beloging to the same group or those without empty lines separating
them).
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Horizontal alignment is required for the module names and lists of
imported symbols in contiguous import declarations (that is, those
beloging to the same group or those without empty lines separating
them).
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Horizontal alignment is required for the module names and lists of
imported symbols in contiguous import declarations (that is, those
beloging to the same group or those without empty lines separating
them).
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
Horizontal alignment is required for the module names and lists of
imported symbols in contiguous import declarations (that is, those
beloging to the same group or those without empty lines separating
them).
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
…40.

Comments must always be line comments, except for pragmas and GHC
options, which can be listed as block comments.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
…40.

Comments must always be line comments, except for pragmas and GHC
options, which can be listed as block comments.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
…40.

Comments must always be line comments, except for pragmas and GHC
options, which can be listed as block comments.
ivanperez-keera added a commit that referenced this issue Apr 1, 2023
…40.

Comments must always be line comments, except for pragmas and GHC
options, which can be listed as block comments.
@ivanperez-keera ivanperez-keera added this to the 0.14.2 milestone Apr 1, 2023
@ivanperez-keera ivanperez-keera self-assigned this Apr 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant