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

DRIVERS-2789 Fix Math Rendering in Client Side Encryption Spec #1557

Merged
merged 5 commits into from
Mar 25, 2024

Conversation

blink1073
Copy link
Member

Please complete the following before merging:

  • Update changelog.
  • Make sure there are generated JSON files from the YAML test files.
  • Test changes in at least one language driver.
  • Test these changes against all server versions and topologies (including standalone, replica set, sharded
    clusters, and serverless).

@blink1073 blink1073 requested a review from a team as a code owner March 25, 2024 11:53
@blink1073 blink1073 requested review from katcharov and W-A-James and removed request for a team and katcharov March 25, 2024 11:53
Copy link
Contributor

@W-A-James W-A-James left a comment

Choose a reason for hiding this comment

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

Running the following command, there are also instances of this pattern in source/client-side-encryption/tests/README.md. It does seem that these predate the conversion to markdown, but this seems like a good place to fix them. Checking further, these were introduced in the conversion of the readme from rst to md.

grep -n '`\$.+\$`' **/*.md

Running the following should fix these instances and might be useful going forward as we continue to convert more specs to markdown

sed -i --regexp-extended 's/`(\$.+\$)`/\1/' **/*.md # Removes wrapping backticks from math rendering in all markdown files and writes results in place

@blink1073
Copy link
Member Author

blink1073 commented Mar 25, 2024

@W-A-James what platform are you using?

When I run those commands I get no output from grep, and sed: 1: "s/`(\$.+\$)`/\1/": \1 not defined in the RE from the second command.

@W-A-James
Copy link
Contributor

@blink1073 I'm running on Ubuntu 20.04 through WSL2.

@blink1073
Copy link
Member Author

blink1073 commented Mar 25, 2024

Thanks, I got grep -E -n '`\$.+\$`' **/*.md to work on MacOS, but I couldn't find an equivalent sed invocation that worked.

Copy link
Contributor

@W-A-James W-A-James left a comment

Choose a reason for hiding this comment

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

Almost done, just a couple unmatched backticks

source/client-side-encryption/tests/README.md Outdated Show resolved Hide resolved
source/client-side-encryption/tests/README.md Outdated Show resolved Hide resolved
source/client-side-encryption/tests/README.md Outdated Show resolved Hide resolved
blink1073 and others added 3 commits March 25, 2024 14:42
Co-authored-by: Warren James <warren.james.dev@gmail.com>
Co-authored-by: Warren James <warren.james.dev@gmail.com>
Co-authored-by: Warren James <warren.james.dev@gmail.com>
@W-A-James W-A-James merged commit bbb335e into mongodb:master Mar 25, 2024
4 checks passed
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.

2 participants