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.

Sign up for GitHub

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

Jump to bottom

Conformace with style guide #14

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

Conformace with style guide #14

ivanperez-keera opened this issue Apr 6, 2023 · 0 comments
Assignees
@ivanperez-keera
Labels
maintenance
Milestone
0.2.1

Comments

@ivanperez-keera
Copy link
Owner

The main implementation file is not conformant with our style guide. For example, by visual inspection, we can see that the following text is misaligned:

https://github.com/ivanperez-keera/yampa-gloss/blob/develop/src/Graphics/Gloss/Interface/FRP/Yampa.hs#L43-L46

We should make sure that this file conforms to the same style guide as Yampa.
@ivanperez-keera ivanperez-keera added this to the 0.3 milestone Apr 6, 2023
@ivanperez-keera ivanperez-keera self-assigned this Apr 6, 2023
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Add module haddock header (KSG Haskell 1.3.0 - 3.3). Refs #14.
594fbb7 
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 6, 2023
@ivanperez-keera
Group imports (KSG Haskell 1.3.0 - 3.5). Refs #14.
b2922b1 
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 6, 2023
@ivanperez-keera
Remove redundant import (KSG Haskell 1.3.0 - 3.5). Refs #14.
efa7850 
Imports should not be redundant (aka. no unused imports).
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Order exports to match module (KSG Haskell 1.3.0 - 3.6.2). Refs #14.
bf010b5 
Where there is an explicit export list, the file should follow the same
structure and order as the export list.
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Document type (KSG Haskell 1.3.0 - 3.6.3). Refs #14.
c50c751 
All top-level definitions should include haddock documentation.
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Document argument (KSG Haskell 1.3.0 - 3.6.3). Refs #14.
001b516 
Each argument function or record field should be documented separately.
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Indent to 2 spaces (KSG Haskell 1.3.0 - 4.2). Refs #14.
0541728 
Each time a new expression or block-like construct is opened, the indent
should increase by two spaces. When the section ends, the indent returns
to the previous indent level. The indent level applies to both Haskell
expressions and comments throughout the block.
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Bring function down to 80 characters (KSG Haskell 1.3.0 - 4.3). Refs #14
99906ea 
.

We set the code limit for Haskell files at 80 characters.
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Remove trailing spaces (KSG Haskell 1.3.0 - 4.5.4.2). Refs #14.
ff6f546 
Do not leave any spaces at the end of any line.
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Remove unnecessary spaces (KSG Haskell 1.3.0 - 4.5.4.3). Refs #14.
959cda2 
Do not leave any extra spaces except as mandated or recommended by these
rules.
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Remove unnecessary parenthesis (KSG Haskell 1.3.0 - 4.6). Refs #14.
d1ffc07 
Do not wrap expressions in parenthesis unnecessarily.
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Re-structure definition to use let (KSG Haskell 1.3.0 - 5.1). Refs #14.
6a3e986 
When allowed, prefer where to let clauses (except as needed in do blocks
and arrow blocks).
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Give variable more descriptive names (KSG Haskell 1.3.0 - 5.4). Refs #14
67bacfd 
.

Prefer longer, more descriptive names to short, abstract ones. For
example, a function that takes a length as argument should not call the
variable l and, instead, call it len or a longer name.
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Add type signatures (KSG Haskell 1.3.0 - 5.6). Refs #14.
546c184 
Type expressions in where and let clauses, even when the type checker
can infer the types.
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Make def local to function that uses it (KSG Haskell 1.3.0 - 5.7). Refs
d5b3620 
#14.

Avoid any compilation warnings. Where the warning is acceptable,
document it with a comment and, optionally, with an indicator that makes
the compiler not trigger the warning.

This commit moves a definition whose name clases with another to the
scope of the only function that uses it, where such a name clash does
not occur.
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Name discarded result of monadic action (KSG Haskell 1.3.0 - 5.7). Refs
d40c738 
#14.

Avoid any compilation warnings. Where the warning is acceptable,
document it with a comment and, optionally, with an indicator that makes
the compiler not trigger the warning.
ivanperez-keera added a commit that referenced this issue Apr 6, 2023
@ivanperez-keera
Document changes in CHANGELOG. Refs #14.
d177f5a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ivanperez-keera ivanperez-keera

Labels
maintenance
Projects
None yet
Milestone
0.2.1
Development

No branches or pull requests
1 participant
@ivanperez-keera