Skip to content

Update code-formatting.adoc #1029

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.

Sign up for GitHub

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

Closed
bllchmbrs wants to merge 2 commits into from
Closed

Update code-formatting.adoc #1029

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
11a5b59
Update code-formatting.adoc
bllchmbrs Mar 24, 2025
ce1c976
Update .hyperlint/reviewer/custom-style-guide/code-formatting.adoc
bllchmbrs Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .hyperlint/reviewer/custom-style-guide/code-formatting.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,8 @@ xref:api:ROOT:admin-api.adoc#get-/v1/broker/pre_restart_probe[`pre_restart_probe
----

This version is incorrect because it starts directly with the xref. According to our style guidelines, sentences should not begin with a command, code snippet, or filename. Instead, the xref should be integrated into a descriptive sentence.


== AsciiDoc include directives

Do NOT make comments on lines that start with `include::`, this just allows us to import other files.
Copy link
Contributor

@asimms41 asimms41 Mar 24, 2025

Choose a reason for hiding this comment

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

Suggested change
Do NOT make comments on lines that start with `include::`, this just allows us to import other files.
Do not make comments on lines that begin with `include::`. This notation inserts the content from another file.

Loading