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

dunai: Consistency of Haskell code style (part 3) #287

Closed
ivanperez-keera opened this issue Jun 4, 2022 · 0 comments
Closed

dunai: Consistency of Haskell code style (part 3) #287

ivanperez-keera opened this issue Jun 4, 2022 · 0 comments

Comments

@ivanperez-keera
Copy link
Owner

ivanperez-keera commented Jun 4, 2022

Starting from this comment, I have looked at this Haskell style guide.

  • Remove TODO notes.
  • Remove commented code.
  • Remove unnecessary vertical space.
  • where stands alone in one line.
  • Indentation is 2 spaces.
@ivanperez-keera ivanperez-keera added this to the (+1) milestone Jun 4, 2022
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
Avoid including TODOs or FIXMEs in the code. Instead, document the issue
as part of the element’s interface, or create an issue for it in the
issue tracker.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
Avoid including TODOs or FIXMEs in the code. Instead, document the issue
as part of the element’s interface, or create an issue for it in the
issue tracker.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
Avoid including TODOs or FIXMEs in the code. Instead, document the issue
as part of the element’s interface, or create an issue for it in the
issue tracker.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
Avoid including TODOs or FIXMEs in the code. Instead, document the issue
as part of the element’s interface, or create an issue for it in the
issue tracker.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
Avoid including TODOs or FIXMEs in the code. Instead, document the issue
as part of the element’s interface, or create an issue for it in the
issue tracker.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
Suggestion: Avoid including commented code, either old or alternative
implementations, or ideas.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
Suggestion: Avoid including commented code, either old or alternative
implementations, or ideas.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
A single blank line should appear: Between consecutive definitions.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
A single blank line should appear: Between consecutive definitions.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
A single blank line should appear: Between consecutive definitions.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
A single blank line should appear: Between consecutive definitions.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
A single blank line should appear: Between consecutive definitions.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
A single blank line should appear: Between consecutive definitions.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
A single blank line should appear: Between consecutive definitions.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
Add vertical space between two separate haddock comments.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
A single blank line should appear: Between consecutive definitions.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
A single blank line should appear: Between consecutive definitions.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
A single blank line should appear: Between consecutive definitions.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
.

Do not leave any extra spaces except as mandated or recommended by these
rules.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
.

Do not leave any extra spaces except as mandated or recommended by these
rules.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
.

Do not leave any extra spaces except as mandated or recommended by these
rules.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
Add vertical space between two separate haddock comments.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

Prefer where appearing alone on a single line, not at the end of a line
or on the same line as the definition it introduces.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

Prefer where appearing alone on a single line, not at the end of a line
or on the same line as the definition it introduces.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

Prefer where appearing alone on a single line, not at the end of a line
or on the same line as the definition it introduces.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

Prefer where appearing alone on a single line, not at the end of a line
or on the same line as the definition it introduces.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

Prefer where appearing alone on a single line, not at the end of a line
or on the same line as the definition it introduces.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

Prefer where appearing alone on a single line, not at the end of a line
or on the same line as the definition it introduces.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

Prefer where appearing alone on a single line, not at the end of a line
or on the same line as the definition it introduces.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

Prefer where appearing alone on a single line, not at the end of a line
or on the same line as the definition it introduces.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
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 Jun 4, 2022
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 Jun 4, 2022
…287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

We set the code limit for Haskell files at 80 characters. A "character"
means any Unicode code point. Any line that would exceed this limit
should be line-wrapped.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…. Refs #287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…. Refs #287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…. Refs #287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…. Refs #287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…. Refs #287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…. Refs #287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…. Refs #287.

We set the code limit for Haskell files at 80 characters. A "character"
means any Unicode code point. Any line that would exceed this limit
should be line-wrapped.
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…. Refs #287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…. Refs #287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…. Refs #287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
ivanperez-keera added a commit that referenced this issue Jun 4, 2022
…. Refs #287.

This commit adjusts comments to occupy as much of 80 columns as
possible. It is a combination of rules 4.3 (column limit = 80), 4.4
(line wrapping should be used to clarify code), and 4.5.4.3 (no
unnecessary spaces).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant