[DOC] Docstring n code guideline #488 #505
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
Codecov Report
@@ Coverage Diff @@
## dev #505 +/- ##
=======================================
Coverage 92.84% 92.84%
=======================================
Files 9 9
Lines 838 838
=======================================
Hits 778 778
Misses 60 60 |
ericmjl
approved these changes
Jul 28, 2019
|
|
||
| .. code-block:: python | ||
| :linenos: | ||
| :emphasize-lines: 1,2,7 |
|
|
||
| Submit Feedback | ||
| ~~~~~~~~~~~~~~~ | ||
| ----------------- |
There was a problem hiding this comment.
Minor formatting suggestion: RST linters will usually make noise about the number of characters used to denote the header needing to match the number of characters in the heading text.
Suggested change
| ----------------- | |
| --------------- |
|
This is great @shandou ! |
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.
PR Description
This PR contains the following additions to
CONTRIBUTING.rst:This PR resolves #488.
PR Checklist
Please ensure that you have done the following:
<your_username>:master, but rather from<your_username>:<branch_name>.AUTHORS.rst.Sorry, but I don't see the
CHANGELOG.rstfile. Where is it?3. [ ] Add a line to
CHANGELOG.rstunder the latest version header (i.e. the one that is "on deck") describing the contribution.- Do use some discretion here; if there are multiple PRs that are related, keep them in a single line.
Quick Check
To do a very quick check that everything is correct, follow these steps below:
make checkfrom pyjanitor's top-level directory. This will automatically run:Once done, please check off the check-box above.
If
make checkdoes not work for you, you can execute the commands listed in the Makefile individually.Documentation Changes
If you are adding documentation changes, please ensure the following:
Relevant Reviewers
Please tag maintainers to review.
Notes to reviewer:
Apologies for taking so long! I am not sure if my doc changes are a bit too detailed. When reviewing, please also check if there are any English issues and correct them as you go (I am not a native speaker). And please do not hesitate in providing feedback!
Thanks a lot! 😃