Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace markblocks with rewritten mark-blocks #10597

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Conversation

andyasp
Copy link
Contributor

@andyasp andyasp commented Feb 6, 2025

What this PR does

This is still a work in progress. Documentation needs to be added and there are references to markblocks that need to be replaced. This has been completed.

Replaces markblocks with a rewritten version uncreatively named mark-blocks.

The motivation for this is that I'm in a situation (don't ask) that requires marking and then later unmarking a large number of blocks.

markblocks as written was limiting for this because:

  • it only supports adding marks, not removing them
  • it only supports blocks specified as an argument, which doesn't work for large lists
  • marking blocks can fail halfway (on the global marker) and then can't be retried without manual intervention
  • when a failure is encountered on a large number of blocks it would be nice to easily resume in a way that does not replicate work or require modifying the input

The rewrite addresses these points.

Checklist

  • Tests updated.
  • Documentation added.
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX].
  • about-versioning.md updated with experimental features.

Copy link
Contributor

github-actions bot commented Feb 10, 2025

@andyasp andyasp marked this pull request as ready for review February 10, 2025 17:02
@@ -0,0 +1,80 @@
# Mark blocks tool
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# Mark blocks tool
# Mark-blocks tool

Copy link
Contributor Author

@andyasp andyasp Feb 10, 2025

Choose a reason for hiding this comment

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

Thank you for this and the other suggestions! I committed most of them and percolated them out the changes to other tools READMEs for consistency. These titles seem tricky though. "Mark-blocks" strikes me as off because it's like a mixture of the actual tool name and a title but neither. I changed it to mark-blocks here and then mark-blocks in the README. Does that seem okay?

docs/internal/tools/mark-blocks.md Outdated Show resolved Hide resolved
tools/mark-blocks/README.md Outdated Show resolved Hide resolved
tools/mark-blocks/README.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants