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.

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

Jump to bottom

Escape code blocks in rustdocs with text attribute #270

Merged
merged 7 commits into from
Sep 11, 2024
Merged

Escape code blocks in rustdocs with text attribute #270

merged 7 commits into from
Sep 11, 2024

Conversation

alexsnaps
Copy link
Contributor

I split the PR in two:

  • Open the seam to write a test
  • Add the test and propose a fix to impl (which might not be the most elegant, so open for debate 😉 )

Should fix #264

clux
clux reviewed Sep 10, 2024
View reviewed changes
Copy link
Member

@clux clux left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Hey there! Thanks a lot for tackling this. I think the general approach is good. I like the white-space preserving and care here. Potential concern on safety and tests.

Btw; if you have nightly installed you can just fmt.

src/main.rs Outdated Show resolved Hide resolved
src/main.rs Outdated Show resolved Hide resolved
@alexsnaps
fmt
5ff8982 
Signed-off-by: Alex Snaps <[email protected]>
@alexsnaps
Replace with a regex
bb009b4 
Signed-off-by: Alex Snaps <[email protected]>
alexsnaps
alexsnaps commented Sep 10, 2024
View reviewed changes
src/output.rs Outdated Show resolved Hide resolved
clux
clux approved these changes Sep 11, 2024
View reviewed changes
Copy link
Member

@clux clux left a comment

Choose a reason for hiding this comment

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

Very clean now. Appreciate it!

@clux clux merged commit 5cb153a into kube-rs:main Sep 11, 2024
5 checks passed
@clux clux mentioned this pull request Sep 11, 2024
Merged
@alexsnaps alexsnaps deleted the issue-264 branch September 12, 2024 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@clux clux clux approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Removing or replacing backticks from description fields?
2 participants
@alexsnaps @clux