-
-
Notifications
You must be signed in to change notification settings - Fork 52
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
yampa
: Conformance with style guide
#255
Comments
ivanperez-keera
added a commit
that referenced
this issue
Mar 25, 2023
No blank lines separate pragmas, the module haddock declaration, and the module declaration.
ivanperez-keera
added a commit
that referenced
this issue
Mar 25, 2023
No blank lines separate pragmas, the module haddock declaration, and the module declaration.
ivanperez-keera
added a commit
that referenced
this issue
Mar 25, 2023
No blank lines separate pragmas, the module haddock declaration, and the module declaration.
ivanperez-keera
added a commit
that referenced
this issue
Mar 25, 2023
No blank lines separate pragmas, the module haddock declaration, and the module declaration.
ivanperez-keera
added a commit
that referenced
this issue
Mar 25, 2023
#255. 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
Mar 25, 2023
…efs #255. All Haskell files must include a copyright notice in a comment. The copyright notice must be included in a format parseable by Haddock. This commit formats the module comment as a haddock comment and adds information that is missing to comply with our module documentation rule.
ivanperez-keera
added a commit
that referenced
this issue
Mar 25, 2023
…efs #255. All Haskell files must include a copyright notice in a comment. The copyright notice must be included in a format parseable by Haddock. Haddock does not have an Authors field for module declarations, but the original file did. To retain that information in some way, we decide to make this file Copyright of Henrik Nilsson only upon creation.
ivanperez-keera
added a commit
that referenced
this issue
Mar 25, 2023
#255. 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
Mar 25, 2023
#255. 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
Mar 25, 2023
#255. 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
Mar 25, 2023
We set the code limit for Haskell files at 80 characters.
ivanperez-keera
added a commit
that referenced
this issue
Mar 25, 2023
Do not leave any spaces at the end of any line.
ivanperez-keera
added a commit
that referenced
this issue
Mar 25, 2023
Do not leave any spaces at the end of any line.
ivanperez-keera
added a commit
that referenced
this issue
Mar 25, 2023
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
Mar 27, 2023
ivanperez-keera
added a commit
that referenced
this issue
Mar 27, 2023
ivanperez-keera
added a commit
that referenced
this issue
Mar 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
Several files inside
yampa/
are not conformant with our own style guide. These are mainly in the examples directory.A quick search shows the following potential violations:
3 File structure, no blank lines at top
./examples/yampa-game/MainWiimote.hs
./examples/yampa-game/MainBouncingBox.hs
./examples/yampa-game/IdentityList.hs
./examples/yampa-game/MainCircleMouse.hs
./examples/Diagrams.hs
./examples/TailgatingDetector/TailgatingDetector.hs
./examples/Testing.hs
./src/FRP/Yampa/InternalCore.hs
./src/FRP/Yampa.hs
3.3 All Haskell files must include a copyright notice in a comment
examples/yampa-game/MainWiimote.hs
examples/yampa-game/MainBouncingBox.hs
examples/yampa-game/IdentityList.hs
examples/yampa-game/YampaSDL.hs
examples/yampa-game/MainCircleMouse.hs
examples/Core.hs
examples/Diagrams.hs
examples/Elevator/Elevator.hs
examples/Testing.hs
4.3 The column limit for Haskell files is 80 characters
tests/HaddockCoverage.hs
examples/yampa-game/MainWiimote.hs
examples/yampa-game/MainCircleMouse.hs
examples/Diagrams.hs
examples/TailgatingDetector/TestTGMain.hs
examples/Testing.hs
src/FRP/Yampa/Scan.hs
src/FRP/Yampa/Integration.hs
src/FRP/Yampa/InternalCore.hs
src/FRP/Yampa/Delays.hs
src/FRP/Yampa/Random.hs
src/FRP/Yampa/Hybrid.hs
src/FRP/Yampa/Arrow.hs
src/FRP/Yampa/Basic.hs
src/FRP/Yampa/EventS.hs
src/FRP/Yampa/Loop.hs
src/FRP/Yampa/Diagnostics.hs
src/FRP/Yampa/Time.hs
src/FRP/Yampa/Event.hs
src/FRP/Yampa/Switches.hs
src/FRP/Yampa/Simulation.hs
src/FRP/Yampa/Conditional.hs
src/FRP/Yampa/Task.hs
src/FRP/Yampa.hs
4.5.4.2 No trailing spaces
examples/yampa-game/MainWiimote.hs
examples/yampa-game/MainBouncingBox.hs
4.7 Comments must always be line comments
./examples/yampa-game/IdentityList.hs
Notes
Many of the lines over 80 should not be broken down at this point. They may contain links or sessions and those should be kept as they are.
The text was updated successfully, but these errors were encountered: