Skip to content

Conversation

@dwhswenson
Copy link
Member

This PR will clean up the compiling subpackage such that the gendocs script creates complete and suitable documentation for the built-in plugins. This primarily involves adding descriptions and type information.

@codecov
Copy link

codecov bot commented Nov 5, 2021

Codecov Report

Merging #67 (a74d29d) into main (59bc1b9) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##              main       #67   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           58        58           
  Lines         2321      2314    -7     
=========================================
- Hits          2321      2314    -7     
Impacted Files Coverage Δ
paths_cli/compiling/_gendocs/docs_generator.py 100.00% <100.00%> (ø)
paths_cli/compiling/_gendocs/json_type_handlers.py 100.00% <100.00%> (ø)
paths_cli/compiling/cvs.py 100.00% <100.00%> (ø)
paths_cli/compiling/engines.py 100.00% <100.00%> (ø)
paths_cli/compiling/gendocs.py 100.00% <100.00%> (ø)
paths_cli/compiling/json_type.py 100.00% <100.00%> (ø)
paths_cli/compiling/networks.py 100.00% <100.00%> (ø)
paths_cli/compiling/plugins.py 100.00% <100.00%> (ø)
paths_cli/compiling/root_compiler.py 100.00% <100.00%> (ø)
paths_cli/compiling/schemes.py 100.00% <100.00%> (ø)
... and 21 more

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 59bc1b9...a74d29d. Read the comment docs.

@dwhswenson dwhswenson mentioned this pull request Nov 5, 2021
4 tasks
@dwhswenson dwhswenson changed the title [WIP] Fill in information for compile docs Fill in information for compile docs Nov 7, 2021
@dwhswenson
Copy link
Member Author

This is ready for review and comment. I will leave it open for at least 24 hours, merging no earlier than Mon 08 Nov 17:00 GMT (12:00 my local).

CodeClimate had complaints, but they were all about similarity in code that is using a template (like plugins using the same keyword arguments, and only differing the strings that were reported.) Template similarity is not real similarity (since it's already refactored).

Copy link
Member

@sroet sroet left a comment

Choose a reason for hiding this comment

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

A question about seemingly dropped functionality, leftover old code, and a typo, LGTM otherwise

Co-authored-by: Sander Roet <sanderroet@hotmail.com>
Copy link
Member

@sroet sroet left a comment

Choose a reason for hiding this comment

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

LGTM!

@dwhswenson dwhswenson merged commit f9cd13d into openpathsampling:main Nov 8, 2021
@dwhswenson dwhswenson deleted the compile-docs branch November 8, 2021 17:11
@dwhswenson dwhswenson added the enhancement New feature or request label May 5, 2024
@dwhswenson dwhswenson mentioned this pull request Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants