BBH pipeline: prompt to edit README.md #6454
Open
Conversation
This file contains 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
knelli2
requested changes
Jan 30, 2025
Comment on lines
425
to
+426
| MaxIts: 100 | ||
| Verbosity: Quiet | ||
| Verbosity: Silent |
There was a problem hiding this comment.
Leave these as quiet. We don't write this information out anywhere else (even though maybe we should) and it's useful to know. Also, it's not affecting performance (that I know of)
Comment on lines
+409
to
+413
| "--edit-readme/--no-edit-readme", | ||
| default=None, | ||
| help=( | ||
| "Edit the README file in the pipeline directory or run directory. " | ||
| "If not specified, a prompt will ask whether to edit the README." |
There was a problem hiding this comment.
I'm not a huge fan of always being prompted for this. I'd like the option, but just not being forced to do it by default. I think this should just be a bool that defaults to false.
There was a problem hiding this comment.
Without the prompt there's little point to have the option. The idea is to encourage writing notes into a readme file.
Comment on lines
+408
to
+416
| # Edit README | ||
| readme = ( | ||
| Path(pipeline_dir or segments_dir or run_dir or Path.cwd()) | ||
| / "README.md" | ||
| ) | ||
| if edit_readme or ( | ||
| edit_readme is None and click.confirm(f"Edit {readme}?", default=True) | ||
| ): | ||
| click.edit(filename=readme) |
There was a problem hiding this comment.
Is there a way to not repeat this or the click option multiple times?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Proposed changes
When starting runs, prompt to edit the README.md file. I hope this helps keeping better track of notes for each run. Can be disabled on the command line.
Upgrade instructions
Code review checklist
make docto generate the documentation locally intoBUILD_DIR/docs/html.Then open
index.html.code review guide.
bugfixornew featureif appropriate.Further comments