Skip to content

Existing docs use inline code blocks in many places #1713

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
Open
brackendawson opened this issue Mar 22, 2025 · 0 comments · May be fixed by #1714
Open

Existing docs use inline code blocks in many places #1713

brackendawson opened this issue Mar 22, 2025 · 0 comments · May be fixed by #1714

Comments

@brackendawson
Copy link
Collaborator

Noticed that existing docs use code blocks in many places so tried to follow that even though not supported by godoc. Updated to use quote 😄 Possibly something to consider over time is updating the other spots in the docs that use code block style. For example:

https://github.com/techfg/testify/blob/098128fd102520c289cc5aef04afa388f10998a9/assert/assertions.go#L1592-L1593
https://github.com/techfg/testify/blob/098128fd102520c289cc5aef04afa388f10998a9/require/doc.go#L25-L26

Originally posted by @techfg in #1709 (comment)
@brackendawson brackendawson linked a pull request Mar 22, 2025 that will close this issue
Open
@brackendawson brackendawson changed the title Existing docs use code blocks in many places Existing docs use inline code blocks in many places Mar 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Remove ineffective inline code blocks brackendawson/testify
1 participant
@brackendawson