Conversation
Aske-Rosted
approved these changes
Apr 19, 2024
Collaborator
Aske-Rosted
left a comment
Aske-Rosted
left a comment
There was a problem hiding this comment.
Just a few comments on the wording but otherwise looks good.
| ------------ | ||
|
|
||
| To ensure consistency in code style and adherence to select best practices, we **require** that all developers use :code:`black`, :code:`flake8`, :code:`mypy`, :code:`pydocstyle`, and :code:`docformatter` for automatically formatting and checking their code. This can conveniently be done using pre-commit hooks. To set this up, first make sure that you have installed the :code:`pre-commit` python package. It comes with included when installing |graphnet|\ GraphNeT with the :code:`develop` tag, i.e., :code:`pip install -e .[develop]`. Then, do | ||
|
|
Collaborator
There was a problem hiding this comment.
It comes with included when installing... ➡️ It is included when installing...
| pre-commit install | ||
|
|
||
|
|
||
| Then, everytime you commit a change, your code and docstrings will automatically be formatted using :code:`black` and :code:`docformatter`, and :code:`flake8`, :code:`mypy`, and :code:`pydocstyle` will check for errors and adherence to PEP8, PEP257, and static typing. See an illustration of the concept below: |
Collaborator
There was a problem hiding this comment.
A lot of and...
... :code:black and :code:docformatter, and :code:flake8, :code:mypy, and :code:pydocstyle will check for errors and adherence to PEP8, PEP257, and static typing....
⬇️
... :code:black and :code:docformatter, while :code:flake8, :code:mypy, and :code:pydocstyle will check for errors, adherence to PEP8, PEP257, and static typing.
Would to me sound a bit better, if I am reading it correctly...
Collaborator
Author
|
Thank you very much for spotting those flaws! I have updated the language. |
This was referenced Apr 19, 2024
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR is the first in a series of updates to the documentation for graphnet hosted here. Closes #420 .
The main change in this PR is an installation matrix (see screenshot) that allows users to click their way to installation commands. To make it easier to review these changes, I've zipped the html files html.zip. When you unzip the folder and open the
index.html, a local version of the documentation page should open.To accommodate the different cuda versions, the
torch_gpu.txtfile undergraphnet/requirementhas been split into two, each representing a supported cuda version. The versions chosen here are from what is supported by PyG.Minor changes:
The structure of the documentation is changed slightly under
graphnet/docs. Instead of relying on one-off python scripts to convert static.mdfiles into the.rstfiles (which is whatsphinxrequires), the files are now written in plain.rst. These conversion scripts have been deleted. The structure of the documentation is now:which we can expand upon in future pull requests.