This repository has been archived by the owner on Dec 7, 2022. It is now read-only.
Add note to convert ported docstrings #3055
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
bmbouter
reviewed
Jun 12, 2017
|
|
||
| PUP-2 TODO(asmacdo)link adopted the use of Google Style Docstrings TODO(asmacdo)link. When developers port code from Pulp 2 to Pulp 3, they should also convert all the docstrings to the new style. |
There was a problem hiding this comment.
I went to review this, but it looks like it is still a work in progress. We shouldn't commit TODOs to the docs so maybe put a WIP? I can review whenever if you put a comment w/ my nick on it.
There was a problem hiding this comment.
I missed that change in git. The corrected links are pushed.
asmacdo
force-pushed
the
google-style-contrib
branch
from
ec27fac
to
ffec23e
Compare
|
@bmbouter ready for review |
werwty
suggested changes
Jun 12, 2017
|
|
||
| `PUP-2 <https://github.com/pulp/pups/blob/master/pup-0002.md>`_ adopted Google style for :ref:`google-docstrings`. When developers port code from Pulp 2 to Pulp 3, they should also convert all the docstrings to the new style. vim-style regexes can be used to speed up the process. Together, these will convert all of the parameters to Google Style:: |
There was a problem hiding this comment.
extra space at the beginning of this line is causing styling issue
|
|
||
| `PUP-2 <https://github.com/pulp/pups/blob/master/pup-0002.md>`_ adopted Google style for :ref:`google-docstrings`. When developers port code from Pulp 2 to Pulp 3, they should also convert all the docstrings to the new style. vim-style regexes can be used to speed up the process. Together, these will convert all of the parameters to Google Style:: |
asmacdo
force-pushed
the
google-style-contrib
branch
from
ffec23e
to
e0dbed7
Compare
werwty
approved these changes
Jun 12, 2017
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