Skip to content

Remove outdated unsupported YAML documentation comments - #886

Merged
jviotti merged 1 commit into
mainfrom
outdated
Sep 24, 2026
Merged

jviotti merged 1 commit into
mainfrom
outdated

Conversation

@jviotti

@jviotti jviotti commented Sep 24, 2026 •

Copy link
Copy Markdown
Member

Signed-off-by: Juan Cruz Viotti jv@jviotti.com

Review in cubic

Signed-off-by: Juan Cruz Viotti <jv@jviotti.com>

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

1 issue found across 2 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="docs/lint.markdown">

<violation number="1" location="docs/lint.markdown:42">
P2: `--format/-m` still rejects invocations without `--fix/-f`, so this paragraph implies formatting works standalone. Restore the prerequisite before describing its formatting behavior.</violation>
</file>

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread docs/lint.markdown
Comment on lines +42 to +45
When `--format/-m` is set, the output file is always written with proper
formatting (equivalent to running `fmt`), even if there are no lint issues to
fix. Use `--keep-ordering/-k` with `--format/-m` to preserve key ordering
during formatting.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2: --format/-m still rejects invocations without --fix/-f, so this paragraph implies formatting works standalone. Restore the prerequisite before describing its formatting behavior.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/lint.markdown, line 42:

<comment>`--format/-m` still rejects invocations without `--fix/-f`, so this paragraph implies formatting works standalone. Restore the prerequisite before describing its formatting behavior.</comment>

<file context>
@@ -39,13 +39,10 @@ automatically fix many of them.
-written with proper formatting (equivalent to running `fmt`), even if there
-are no lint issues to fix. Use `--keep-ordering/-k` with `--format/-m` to
-preserve key ordering during formatting.
+When `--format/-m` is set, the output file is always written with proper
+formatting (equivalent to running `fmt`), even if there are no lint issues to
+fix. Use `--keep-ordering/-k` with `--format/-m` to preserve key ordering
</file context>
Suggested change
When `--format/-m` is set, the output file is always written with proper
formatting (equivalent to running `fmt`), even if there are no lint issues to
fix. Use `--keep-ordering/-k` with `--format/-m` to preserve key ordering
during formatting.
The `--format/-m` option requires `--fix/-f`; when set, the output file is always written with proper
formatting (equivalent to running `fmt`), even if there are no lint issues to
fix. Use `--keep-ordering/-k` with `--format/-m` to preserve key ordering
during formatting.

@jviotti
jviotti merged commit d3656d1 into main Sep 24, 2026
16 checks passed
@jviotti
jviotti deleted the outdated branch September 24, 2026 20:13
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.

1 participant