[DOC] 090_contribute: per-line inline annotation markers#41
Draft
dnplkndll wants to merge 2 commits into
Draft
Conversation
The current guide says lines can be reordered and grouped into a "logical" block with a single consolidated comment. Recent reviewer feedback consistently asks the opposite — each analysis line gets its own inline marker, no consolidated author-blocks above multi-line groups. Update the Note to describe the inline-per-line convention and add a short example showing the expected shape.
Align the annotation guidance with hbrunn's review on OCA#5647 ('don't add this for empty lists') — empty work-file sections are left blank; only populated sections get an inline # DONE / # NOTHING TO DO marker.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
Updates the annotation Note in `docsource/090_contribute.rst` to describe the inline-per-line marker convention that reviewers consistently ask for.
Current text allows grouping:
Proposed text describes the inline-per-line convention:
Plus:
Why
The current "logical block consolidated comments" guidance contradicts what reviewers ask for on recent 19.0 PRs. Several recent PRs have been sent back with requests to expand consolidated blocks into inline per-line markers. Aligning the doc with the practice reduces re-review cycles.
Scope
Draft, fork-only for review. Behavioural change is purely editorial — no code or workflow impact. If you sign off, the same diff is a candidate to propose upstream against `OCA/OpenUpgrade:documentation`.
Companion PR for the commit-prefix Note is opened as a separate diff.