Skip to content

Conversation

@joaomcteixeira
Copy link
Member

@joaomcteixeira joaomcteixeira commented Jun 13, 2022

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

  • You have stick to Python. Talk with 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's a (state) purpose
  • 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 install 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:

Now, haddock3-cfg can also output the general parameters for modules combined with those of the requested module.

@joaomcteixeira joaomcteixeira marked this pull request as ready for review June 13, 2022 11:44
@codecov-commenter
Copy link

codecov-commenter commented Jun 13, 2022

Codecov Report

Merging #476 (ea827a9) into main (5abbdf3) will increase coverage by 0.10%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #476      +/-   ##
==========================================
+ Coverage   72.22%   72.32%   +0.10%     
==========================================
  Files          95       95              
  Lines        6080     6103      +23     
==========================================
+ Hits         4391     4414      +23     
  Misses       1689     1689              
Impacted Files Coverage Δ
src/haddock/clis/cli_cfg.py 83.78% <100.00%> (+4.47%) ⬆️
src/haddock/gear/yaml2cfg.py 94.82% <100.00%> (+0.28%) ⬆️
tests/__init__.py 100.00% <100.00%> (ø)
tests/test_cli_cfg.py 100.00% <100.00%> (ø)
tests/test_gear_yaml2cfg.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5abbdf3...ea827a9. Read the comment docs.

@joaomcteixeira joaomcteixeira linked an issue Jun 13, 2022 that may be closed by this pull request
@joaomcteixeira joaomcteixeira self-assigned this Jun 13, 2022
@joaomcteixeira joaomcteixeira added the enhancement Improving something in the codebase label Jun 13, 2022
@joaomcteixeira joaomcteixeira added this to the v3.0.0 stable release milestone Jun 13, 2022
Copy link
Member

@amjjbonvin amjjbonvin left a comment

Choose a reason for hiding this comment

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

Do the global parameter vary per module? If not why not have a separate listing for those instead of adding the -g option to all modules?

@joaomcteixeira
Copy link
Member Author

Global parameters do not vary per module. We can have a separate listing, but it should be in the same command line. For example:

haddock-cfg -m topoaa -g -> outputs also the general parameters
haddock-cfg -G -> outputs only the general parameters

I think these options should be kept in the same command-line because in this way there's a single place to read the docs. What do you think? I can make it in this same PR.

@amjjbonvin
Copy link
Member

Sounds like a good idea!

@joaomcteixeira
Copy link
Member Author

Add what we discussed @amjjbonvin . But Instead of haddock-cfg -G we can use:

haddock-cfg -g
haddock-cfg -m MODULE
haddock-cfg -m MODULE -g

@joaomcteixeira joaomcteixeira merged commit b345847 into haddocking:main Jun 23, 2022
@joaomcteixeira joaomcteixeira deleted the i356 branch June 23, 2022 07:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Improving something in the codebase

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add global and module's general parameters to haddock3-cfg

3 participants