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

yampa: Conformance with style guide #266

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

yampa: Conformance with style guide #266

ivanperez-keera opened this issue Apr 29, 2023 · 0 comments
Assignees
@ivanperez-keera
Labels
enhancement
Milestone
Yampa 0.14.3

Comments

@ivanperez-keera
Copy link
Owner

ivanperez-keera commented Apr 29, 2023 •
edited
Loading

Several issues in the past have looked at conformance with the style guide, namely #255, #215, #214, #213, #212, #211, #207, #206, #205, #202, #200.

Although the current code is mostly conformant and fully conforms with the main rules and with any rules we can (currently) detect automatically, some suggestions that we really want implemented and some mandatory rules, are not being implemented. These include, for example, spaces after commas, where in a separate line, and explicit imports.

To finalize anything related to conformance with style guides in the Yampa library, we should do a final pass for style and make sure all code is conformant with the current recommendations.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Make export list explicit (KSG Haskell 1.3.0 - 3.4). Refs #266.
bd735ae 
The module declaration should explicitly list the definitions exported
by the module.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Make export list explicit (KSG Haskell 1.3.0 - 3.4). Refs #266.
4c8215e 
The module declaration should explicitly list the definitions exported
by the module.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Add haddock indicators to export list (KSG Haskell 1.3.0 - 3.4…
324fe72 
…). Refs #266.

The module declaration should use haddock indicators to group the
elements exported so as to facilitate navigating the documentation.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Add haddock indicators to export list (KSG Haskell 1.3.0 - 3.4…
ce6aaeb 
…). Refs #266.

The module declaration should use haddock indicators to group the
elements exported so as to facilitate navigating the documentation.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
434887e 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
f3112f2 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
a09357c 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
ca1f4d0 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
8c7a6dd 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
336aa79 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
886cc5c 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
5da9f3e 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
cb80c07 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
79d4876 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
db14629 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
72c9c56 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
fddf407 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
144da7b 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
4055674 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
19fb966 
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 29, 2023
@ivanperez-keera
yampa: Group imports (KSG Haskell 1.3.0 - 3.5). Refs #266.
1cb1daf 
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 29, 2023
@ivanperez-keera
yampa: Sort imports in alphabetical order (KSG Haskell 1.3.0 - 3.5). …
8cdf21f 
…Refs #266.

Imports belonging to the same group should be listed in alphabetical order.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Sort imports in alphabetical order (KSG Haskell 1.3.0 - 3.5). …
7466eff 
…Refs #266.

Elements imported from a module should be listed in alphabetical order.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Make imports explicit (KSG Haskell 1.3.0 - 3.5). Refs #266.
af343a2 
Imports should be explicit (aka. no wildcard imports).
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Make imports explicit (KSG Haskell 1.3.0 - 3.5). Refs #266.
2f3af4b 
Imports should be explicit (aka. no wildcard imports).
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Make imports explicit (KSG Haskell 1.3.0 - 3.5). Refs #266.
f0ca2d5 
Imports should be explicit (aka. no wildcard imports).
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Make imports explicit (KSG Haskell 1.3.0 - 3.5). Refs #266.
a2aef19 
Imports should be explicit (aka. no wildcard imports).
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Make imports explicit (KSG Haskell 1.3.0 - 3.5). Refs #266.
4f08bab 
Imports should be explicit (aka. no wildcard imports).
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Make imports explicit (KSG Haskell 1.3.0 - 3.5). Refs #266.
7cc386f 
Imports should be explicit (aka. no wildcard imports).
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Remove redundant bracket (KSG Haskell 1.3.0 - 4.6). Refs #266.
010b588 
Do not wrap expressions in parenthesis unnecessarily.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Move definitions to separate line (KSG Haskell 1.3.0 - 5.2). R…
6e12a2f 
…efs #266.

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 Apr 29, 2023
@ivanperez-keera
yampa: Move definitions to separate line (KSG Haskell 1.3.0 - 5.2). R…
64a5daa 
…efs #266.

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 Apr 29, 2023
@ivanperez-keera
yampa: Move definitions to separate line (KSG Haskell 1.3.0 - 5.2). R…
070c2a1 
…efs #266.

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 Apr 29, 2023
@ivanperez-keera
yampa: Move definitions to separate line (KSG Haskell 1.3.0 - 5.2). R…
1625c4a 
…efs #266.

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 Apr 29, 2023
@ivanperez-keera
yampa: Prefer where to let (KSG Haskell 1.3.0 - 5.1). Refs #266.
6ba8d75 
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 29, 2023
@ivanperez-keera
yampa: Prefer where to let (KSG Haskell 1.3.0 - 5.1). Refs #266.
37043e6 
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 29, 2023
@ivanperez-keera
yampa: Prefer where to let (KSG Haskell 1.3.0 - 5.1). Refs #266.
f27320d 
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 29, 2023
@ivanperez-keera
yampa: Prefer where to let (KSG Haskell 1.3.0 - 5.1). Refs #266.
ca35ddd 
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 29, 2023
@ivanperez-keera
yampa: Prefer where to let (KSG Haskell 1.3.0 - 5.1). Refs #266.
b542c3e 
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 29, 2023
@ivanperez-keera
yampa: Prefer where to let (KSG Haskell 1.3.0 - 5.1). Refs #266.
3ed316d 
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 29, 2023
@ivanperez-keera
yampa: Remove vertical space (KSG Haskell 1.3.0 - 5.5). Refs #266.
4f943df 
Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Remove vertical space (KSG Haskell 1.3.0 - 5.5). Refs #266.
724a8e8 
Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Remove vertical space (KSG Haskell 1.3.0 - 5.5). Refs #266.
636a469 
Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Remove vertical space (KSG Haskell 1.3.0 - 5.5). Refs #266.
cacf313 
Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Remove vertical space (KSG Haskell 1.3.0 - 5.5). Refs #266.
cb9a63a 
Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Remove vertical space (KSG Haskell 1.3.0 - 5.5). Refs #266.
3006b7d 
Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Remove vertical space (KSG Haskell 1.3.0 - 5.5). Refs #266.
ded5434 
Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Remove vertical space (KSG Haskell 1.3.0 - 5.5). Refs #266.
3ac406a 
Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Add period to end of haddock messages for consistency (KSG Has…
bf2eb4f 
…kell 1.3.0 - 5.5). Refs #266.

Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Add period to end of haddock messages for consistency (KSG Has…
7a1bcfb 
…kell 1.3.0 - 5.5). Refs #266.

Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Add period to end of haddock messages for consistency (KSG Has…
95e3be4 
…kell 1.3.0 - 5.5). Refs #266.

Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Add period to end of haddock messages for consistency (KSG Has…
17615a6 
…kell 1.3.0 - 5.5). Refs #266.

Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Add period to end of haddock messages for consistency (KSG Has…
1eb95f8 
…kell 1.3.0 - 5.5). Refs #266.

Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Add period to end of haddock messages for consistency (KSG Has…
b73c101 
…kell 1.3.0 - 5.5). Refs #266.

Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Add period to end of haddock messages for consistency (KSG Has…
4fbee2b 
…kell 1.3.0 - 5.5). Refs #266.

Prefer consistent names, structure, and improvements over localized
optimizations. For example, a module might define an API in a particular
order, and a module with a similar but distinct API might list elements
in a completely different order. Whenever possible, code should be
consistent.
ivanperez-keera added a commit that referenced this issue Apr 29, 2023
@ivanperez-keera
yampa: Document changes in CHANGELOG. Refs #266.
08d775c
@ivanperez-keera ivanperez-keera added this to the Yampa 0.(14+X).(2+Y) milestone Jun 8, 2023
@ivanperez-keera ivanperez-keera self-assigned this Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ivanperez-keera ivanperez-keera

Labels
enhancement
Projects
None yet
Milestone
Yampa 0.14.3
Development

No branches or pull requests
1 participant
@ivanperez-keera