Skip to content

Conversation

@mgiulini
Copy link
Contributor

You are about to submit a new Pull Request. Before continuing make sure you read the contributing guidelines and that you comply with the following criteria:

  • You have sticked to Python. Please talk to us before adding other programming languages to HADDOCK3
  • Your PR is about CNS
  • Your code is well documented: proper docstrings and explanatory comments for those tricky parts
  • You structured the code into small functions as much as possible. You can use classes if there is a (state) purpose
  • Your code follows our coding style
  • You wrote tests for the new code
  • tox tests pass. Run tox command inside the repository folder
  • -test.cfg examples execute without errors. Inside examples/ run python run_tests.py -b
  • PR does not add any dependencies, unless permission granted by the HADDOCK team
  • PR does not break licensing
  • Your PR is about writing documentation for already existing code 🔥
  • Your PR is about writing tests for already existing code :godmode:

Closes #814

@mgiulini mgiulini self-assigned this Feb 23, 2024
@mgiulini mgiulini added the documentation Improve docs label Feb 23, 2024
@mgiulini mgiulini marked this pull request as ready for review February 26, 2024 14:50
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to add the {:target="_blank"} after the links so a new tab is created ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mmm I don't know..that md code will be also visualized on github and I don't like having hundreds of pages opening while browsing things

Copy link
Contributor

@VGPReys VGPReys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great improvements ! Nice work

@mgiulini mgiulini merged commit 7e55685 into main Feb 27, 2024
@mgiulini mgiulini deleted the low_level_docs branch February 27, 2024 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improve docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

low level improvements to autogenerated documentation

3 participants