diff options
| author | Chiara Marmo <chiara.marmo@inria.fr> | 2021-05-03 23:56:48 +0200 |
|---|---|---|
| committer | Chiara Marmo <chiara.marmo@inria.fr> | 2021-05-03 23:56:48 +0200 |
| commit | 5ccd7e8d2be3a75ba1a0672b49e7e28886bad51d (patch) | |
| tree | 2177eb427bd6c5ac5c6c75f97a1f1a6e7fe9a77c /doc/source | |
| parent | 839ee68ab02c334f2ea2e2f05ca0142ff85cb254 (diff) | |
| download | numpy-5ccd7e8d2be3a75ba1a0672b49e7e28886bad51d.tar.gz | |
Fix markdown formatting. Remove unuseful 'py'.
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/dev/reviewer_guidelines.rst | 40 |
1 files changed, 15 insertions, 25 deletions
diff --git a/doc/source/dev/reviewer_guidelines.rst b/doc/source/dev/reviewer_guidelines.rst index bdc69fe45..f05014e98 100644 --- a/doc/source/dev/reviewer_guidelines.rst +++ b/doc/source/dev/reviewer_guidelines.rst @@ -126,29 +126,25 @@ replies <https://github.com/settings/replies/>`_ for reviewing: **Usage question** :: - You are asking a usage question. The issue tracker is for bugs and new - features. I'm going to close this issue, feel free to ask for help via - our [help channels](https://numpy.org/gethelp/). + You are asking a usage question. The issue tracker is for bugs and new features. + I'm going to close this issue, feel free to ask for help via our [help channels](https://numpy.org/gethelp/). **You’re welcome to update the docs** :: - Please feel free to offer a pull request updating the documentation if - you feel it could be improved. + Please feel free to offer a pull request updating the documentation if you feel it could be improved. **Self-contained example for bug** :: - Please provide a [self-contained example code] - (https://stackoverflow.com/help/mcve), including imports and data - (if possible), so that other contributors can just run it and reproduce - your issue. Ideally your example code should be minimal. + Please provide a [self-contained example code] (https://stackoverflow.com/help/mcve), including imports and data (if possible), so that other contributors can just run it and reproduce your issue. + Ideally your example code should be minimal. **Software versions** :: To help diagnose your issue, please paste the output of: - ```py + ``` python -c 'import numpy; print(numpy.version.version)' ``` Thanks. @@ -156,36 +152,30 @@ replies <https://github.com/settings/replies/>`_ for reviewing: **Code blocks** :: - Readability can be greatly improved if you - [format](https://help.github.com/articles/creating-and-highlighting-code-blocks/) - your code snippets and complete error messages appropriately. - You can edit your issue descriptions and comments at any time to - improve readability. This helps maintainers a lot. Thanks! + Readability can be greatly improved if you [format](https://help.github.com/articles/creating-and-highlighting-code-blocks/) your code snippets and complete error messages appropriately. + You can edit your issue descriptions and comments at any time to improve readability. + This helps maintainers a lot. Thanks! **Linking to code** :: - For clarity's sake, you can link to code like - [this](https://help.github.com/articles/creating-a-permanent-link-to-a-code-snippet/). + For clarity's sake, you can link to code like [this](https://help.github.com/articles/creating-a-permanent-link-to-a-code-snippet/). **Better description and title** :: - Please make the title of the PR more descriptive. The title will become - the commit message when this is merged. You should state what issue - (or PR) it fixes/resolves in the description using the syntax described - [here](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword). + Please make the title of the PR more descriptive. + The title will become the commit message when this is merged. + You should state what issue (or PR) it fixes/resolves in the description using the syntax described [here](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword). **Regression test needed** :: - Please add a [non-regression test](https://en.wikipedia.org/wiki/Non-regression_testing) - that would fail at main but pass in this PR. + Please add a [non-regression test](https://en.wikipedia.org/wiki/Non-regression_testing) that would fail at main but pass in this PR. **Don’t change unrelated** :: - Please do not change unrelated lines. It makes your contribution harder - to review and may introduce merge conflicts to other pull requests. + Please do not change unrelated lines. It makes your contribution harder to review and may introduce merge conflicts to other pull requests. .. include:: gitwash/git_links.inc |
