This repository has been archived by the owner on Dec 7, 2022. It is now read-only.
Create style guide for Pulp 3+ #3035
Merged
Conversation
This file contains 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
mhrivnak
approved these changes
Jun 2, 2017
docs/contributing/style_guide.rst
Outdated
| #. Modules should not include license information. | ||
| #. The type of each Args value should be included after the variable name in parentheses. The type of each Returns value should be the first item on the line. | ||
| #. Following the type of Args and Returns values, there will be a colon and a single space followed by the description. Additional spaces should not be used to align types and descriptions. | ||
| #. Fields and Relations sections will be used when documenting fields on Django models. The Fields section will be used for non-related fields on Model classes, the Relations section will be used for related fields on Model classes. |
There was a problem hiding this comment.
The second sentence is really two, so you can end with "on Model classes. The Relations section..."
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
https://pulp.plan.io/issues/2347