Addition of description for Ford #194
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
certik
approved these changes
May 18, 2020
milancurcic
approved these changes
May 18, 2020
|
Thank you @jvdp1. This a small and straightforward PR, so I will merge it. |
|
LGTM. I typically put spaces between the double bang and text but as long as it builds and renders correctly I have no objections. |
Indeed, I agree, we should aim for the docstrings to be readable from the code as well. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addition of small descriptions of the different modules for Ford.
Questions: Should we add descritpions for the different functions in the code? Or only in the specs? Or is it possible to combine specs and code through Ford?
@zbeekman @milancurcic @certik