docs: range annotations #133

Open
noe.trevino wants to merge 4 commits from feature-108/range-docs into feature-108/range-outputs
Owner

Stacked on #132. Retarget to the umbrella (#127) once the ones below merge.

  • README: Visual-mode annotate, [range]HauntAnnotate, annotate_by_id
  • README: new collapsible "Range Annotations" section (nesting rules link to priority.md, range options, HauntRange, outputs)
  • vimdoc: new haunt-ranges section, plus the HauntRangeConfig tag
  • annotate keymap is now { "n", "x" } in the examples

Calls to look at:

  • hooks aren't in the vimdoc (hooks.lua isn't in minidoc), so they're plain text

  • README q/Q quickfix descriptions don't match their args (older, left alone)

  • every option/function name checked against the code

  • doc/haunt.txt regenerated by CI

Refs #108

Stacked on #132. Retarget to the umbrella (#127) once the ones below merge. - README: Visual-mode annotate, `[range]HauntAnnotate`, `annotate_by_id` - README: new collapsible "Range Annotations" section (nesting rules link to `priority.md`, `range` options, `HauntRange`, outputs) - vimdoc: new `haunt-ranges` section, plus the `HauntRangeConfig` tag - annotate keymap is now `{ "n", "x" }` in the examples Calls to look at: - hooks aren't in the vimdoc (`hooks.lua` isn't in minidoc), so they're plain text - README `q`/`Q` quickfix descriptions don't match their args (older, left alone) - [x] every option/function name checked against the code - [ ] `doc/haunt.txt` regenerated by CI Refs #108
- map annotate in Visual mode too
- add range annotate and annotate_by_id
- list [range]HauntAnnotate [text]

Refs #108
- nesting rules, linked to priority.md
- range options and HauntRange
- range-aware quickfix, picker, sidekick, hooks

Refs #108
- Visual and :[range]HauntAnnotate usage
- nesting rules and range-aware outputs
- map annotate in Visual mode too

Refs #108
docs: note range behaviour in API doc comments
All checks were successful
Auto Assign / assign (pull_request_target) Successful in 1s
CI / config (pull_request) Successful in 4s
CI / Check for debug messages (pull_request) Successful in 9s
CI / stylua (pull_request) Successful in 10s
CI / tests (pull_request) Successful in 22s
CI / docs (pull_request) Has been skipped
CI / release (pull_request) Has been skipped
CI / ci (pull_request) Successful in 0s
1ee542c24e
- tag HauntRangeConfig and its HauntRange link
- picker range labels
- annotate_by_id keeps a range's lines

Refs #108
All checks were successful
Auto Assign / assign (pull_request_target) Successful in 1s
CI / config (pull_request) Successful in 4s
CI / Check for debug messages (pull_request) Successful in 9s
CI / stylua (pull_request) Successful in 10s
CI / tests (pull_request) Successful in 22s
CI / docs (pull_request) Has been skipped
CI / release (pull_request) Has been skipped
CI / ci (pull_request) Successful in 0s
This pull request can be merged automatically.
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin feature-108/range-docs:feature-108/range-docs
git switch feature-108/range-docs

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch feature-108/range-outputs
git merge --no-ff feature-108/range-docs
git switch feature-108/range-docs
git rebase feature-108/range-outputs
git switch feature-108/range-outputs
git merge --ff-only feature-108/range-docs
git switch feature-108/range-docs
git rebase feature-108/range-outputs
git switch feature-108/range-outputs
git merge --no-ff feature-108/range-docs
git switch feature-108/range-outputs
git merge --squash feature-108/range-docs
git switch feature-108/range-outputs
git merge --ff-only feature-108/range-docs
git switch feature-108/range-outputs
git merge feature-108/range-docs
git push origin feature-108/range-outputs
Sign in to join this conversation.
No description provided.