Skip to content

Add help to compile; make it visible in CLI help#76

Merged
dwhswenson merged 3 commits into
openpathsampling:mainfrom
dwhswenson:compile-help
May 9, 2024
Merged

Add help to compile; make it visible in CLI help#76
dwhswenson merged 3 commits into
openpathsampling:mainfrom
dwhswenson:compile-help

Conversation

@dwhswenson

@dwhswenson dwhswenson commented May 5, 2024

Copy link
Copy Markdown
Member

I'm going to leave the wizard hidden for the 0.3 release, but compile is one of the marquee features for this release.

To-do:

  • Needs to link to the page in core docs that discusses default options and how to generate documentation for all installed options.

EDIT: To clarify here, I have made the decision that the Wizard, while a lot of fun, isn't mature enough or well-designed enough to be something I want to commit to maintaining. It also isn't an approach that we should put much effort into expanding/maturing (there are better ways to be user friendly.) It was originally a bit of a response to people who kept saying that OPS was too hard to use because it required working in a Jupyter notebook. Frankly, I think there are better solutions to make that response.

However, I totally intend to leave it in as an easter egg for anyone who finds it, because I find it hilarious. Especially the error demon.

@codecov

codecov Bot commented May 5, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (b05951c) to head (78f967b).

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #76   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          110       110           
  Lines         5416      5416           
=========================================
  Hits          5416      5416           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dwhswenson dwhswenson marked this pull request as ready for review May 5, 2024 04:58
@dwhswenson dwhswenson changed the title [WIP] Add help to compile; make it visible in CLI help Add help to compile; make it visible in CLI help May 5, 2024
@dwhswenson

Copy link
Copy Markdown
Member Author

Changed my mind. We have a circular dependency here:

  • I want the help from compile to link to a spot in the OPS docs explaining the file format of compile. This requires making changes in the OPS docs.
  • The OPS docs explaining the file format of compile are build dynamically, based on the currently installed plugins registered by the compile CLI command. This requires releasing a version of CLI with compile merged in.

So I think the solution is:

  1. Finish the release of CLI 0.3
  2. Merge a docs update into OPS
  3. Push a small change to docs here to link to the OPS docs on the CLI.

This is ready for review and comment. Without review, I will merge this after at least 18 hours, no sooner than Sun 05 May 23:00 GMT (18:00 my local).

@sroet sroet left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM.

EDIT: To clarify here, I have made the decision that the Wizard, while a lot of fun, isn't mature enough or well-designed enough to be something I want to commit to maintaining. It also isn't an approach that we should put much effort into expanding/maturing (there are better ways to be user friendly.) It was originally a bit of a response to people who kept saying that OPS was too hard to use because it required working in a Jupyter notebook. Frankly, I think there are better solutions to make that response.

However, I totally intend to leave it in as an easter egg for anyone who finds it, because I find it hilarious. Especially the error demon.

This is fine by me :)

So I think the solution is:

  1. Finish the release of CLI 0.3
  2. Merge a docs update into OPS
  3. Push a small change to docs here to link to the OPS docs on the CLI.

This looks like a reasonable plan

@dwhswenson dwhswenson merged commit 5dc52b5 into openpathsampling:main May 9, 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants