Skip to content
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

Replace <= and >= with single chars #4576

Merged
merged 2 commits into from
Nov 6, 2024
Merged

Replace <= and >= with single chars #4576

merged 2 commits into from
Nov 6, 2024

Conversation

akeller
Copy link
Member

@akeller akeller commented Nov 5, 2024

Description

Related to #4560 #2719, the markdown linter didn't like >= or <= in some places🤷‍♀️

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@akeller akeller added the d3 Path to Docusaurus 3 label Nov 5, 2024
@akeller akeller requested a review from a team November 5, 2024 20:35
@akeller akeller self-assigned this Nov 5, 2024
@akeller akeller changed the title Replace <= with ≤ Replace <= and >= with single chars Nov 5, 2024
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

🙌

Is this something that works sometimes, but not others? Should we just have a general recommendation to use single characters for this stuff? 🤔

@akeller
Copy link
Member Author

akeller commented Nov 5, 2024

Is this something that works sometimes, but not others? Should we just have a general recommendation to use single characters for this stuff? 🤔

@conceptualshark great question, I did a very superficial investigation and 1 char escaping (\*, for example)seems to work, but 2 chars didn't. Here is an example of what the MDX compilation failure looks like:

Error: MDX compilation failed for file ".../camunda-docs/versioned_docs/version-8.6/reference/notices.md"
Cause: Unexpected character `=` (U+003D) before name, expected a character that can start a name, such as a letter, `$`, or `_`
Details:
{
  "column": 45,
  "message": "Unexpected character `=` (U+003D) before name, expected a character that can start a name, such as a letter, `$`, or `_`",
  "line": 118,
  "name": "118:45",
  "place": {
    "line": 118,
    "column": 45,
    "offset": 3027,
    "_index": 0,
    "_bufferIndex": 44
  },
  "reason": "Unexpected character `=` (U+003D) before name, expected a character that can start a name, such as a letter, `$`, or `_`",
  "ruleId": "unexpected-character",
  "source": "micromark-extension-mdx-jsx",
  "url": "https://github.com/micromark/micromark-extension-mdx-jsx#unexpected-character-at-expected-expect"
}

@akeller akeller merged commit 3797185 into main Nov 6, 2024
8 checks passed
@akeller akeller deleted the less-than-equal-to branch November 6, 2024 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
d3 Path to Docusaurus 3
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants