DOC: understanding code and getting started section to dev doc #7295
Conversation
| The best strategy to better understand the code base is to pick something you | ||
| want to change and start reading the code to figure out how it works. | ||
| When you're in doubt, you can ask questions on the mailing list or on the | ||
| NumPy Github page. It is perfectly okay if your pull requests aren't perfect, |
There was a problem hiding this comment.
Hmm, the github page is for PR and bug reports, guestions should go to the mailing list.
rehassachdeva
force-pushed
the
update_dev_doc
branch
2 times, most recently
from
e876652
to
e185995
Compare
|
Sir, have made both the changes. |
|
|
||
| The best strategy to better understand the code base is to pick something you | ||
| want to change and start reading the code to figure out how it works. | ||
| When you're in doubt, you can ask questions on the mailing list. It is perfectly okay if your pull requests aren't perfect, |
There was a problem hiding this comment.
Wrap lines to 80 or 72 chars, whichever the document appears to use.
There was a problem hiding this comment.
Avoid using contractions. In this case the word "you're" can be removed entirely, "aren't"->"are not".
|
@madphysicist: what's wrong with an informal tone here? This isn't some government policy document; it's directed at (possibly intimidated) potential contributors, trying to reassure them and welcome them into the project. It's not like we avoid contractions when talking to each other... |
|
@njsmith There is nothing wrong with an informal tone as long as all the information is there (which it is in this case). If the goal is to have an accessible and friendly intro, I rescind my comments on the basis that they were motivated by personal preference rather than any objective reasons. I am not a fan of overly complex documentation, but I do generally find it preferable to read concise and correct grammar over informal or chatty documents. |
…ent_environment.rst Updated understanding code section in dev doc wrapped lines, corrected grammar.
rehassachdeva
force-pushed
the
update_dev_doc
branch
from
e185995
to
92fbcaa
Compare
|
@njsmith @madphysicist Have updated, wrapped lines and corrected grammar, didn't change contractions. Please review. Thanks. |
|
That looks nice and welcoming. |
|
Looks good to me -- thanks @rehassachdeva! |
DOC: understanding code and getting started section to dev doc
As noted in Issue #6996. have added the mentioned section to development_environment.rst.
Please review.
Thanks