-
Notifications
You must be signed in to change notification settings - Fork 282
[chore] #189 standardise list symbol #3013
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
base: main
Are you sure you want to change the base?
[chore] #189 standardise list symbol #3013
Conversation
|
This PR contains changes to area(s) that do not have an active SIG/project and will be auto-closed: Such changes may be rejected or put on hold until a new SIG/project is established. Please refer to the Semantic Convention Areas |
534e304 to
b6d584b
Compare
lmolkova
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't believe there is a consensus on #189. this chance does not seem to be beneficial and enforcing it seems to bring more harm then good
|
@lmolkova this is important not just for code formatting but also linting which also enforces that a single style is used within a single page. This gets more difficult to mantain when we are also linting dynamically generated content. Also consider that any page which has a TOC needs to use - for the list symbol. |
12ffb0f to
3a45092
Compare
docs/runtime/jvm-metrics.md
Outdated
| - [`ThreadMXBean#getAllThreadIds()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ThreadMXBean.html#getAllThreadIds--) | ||
| - [`ThreadMXBean#getThreadInfo()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ThreadMXBean.html#getThreadInfo-long:A-) | ||
| - [`ThreadInfo#getThreadState()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ThreadInfo.html#getThreadState--) | ||
| - [`ThreadInfo#isDaemon()`](<https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/ThreadInfo.html#isDaemon()>) (requires Java 9+) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - [`ThreadInfo#isDaemon()`](<https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/ThreadInfo.html#isDaemon()>) (requires Java 9+) | |
| - [`ThreadInfo#isDaemon()`](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/ThreadInfo.html#isDaemon()) (requires Java 9+) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually this is done to easily regex the url when the url contains ), also is valid markdown syntax.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just because its valid markdown syntax is a different question from whether we need this more complex syntax
let's simplify it for now until we have a specific need for it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
have changed it back.
3a45092 to
cd9ea74
Compare
cd9ea74 to
5e2ec3b
Compare
Progresses #189
Changes
This ensures that lists use - as opposed to * as per prettier recommendations.
Note all pages which have a toc also require - to be list symbol.
Important
Pull requests acceptance are subject to the triage process as described in Issue and PR Triage Management.
PRs that do not follow the guidance above, may be automatically rejected and closed.
Merge requirement checklist
[chore]