Skip to content

doc: remove ineffective inline code blocks #1714

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

brackendawson
Copy link
Collaborator

@brackendawson brackendawson commented Mar 22, 2025

Summary

Godoc does not have inline code blocks. Look to the standard library for conventions for inline references to code.

Changes

  • Replace inline code blocks in docs (uses backticks) with formats following the conventions of the standard library.

Motivation

Go doc does not have inline code blocks and backticks are unusual quotes for human readable documentation.

Related issues

Closes #1713

Godoc does not have inline code blocks. Look to the standaed library for conventions for inline references to code.
@brackendawson
Copy link
Collaborator Author

I discovered #1712 while making this change. I also noticed that suite.Suite.Assert() probably isn't necessary, you can just do:

func (s *MySuite) TestIfy() {
    s.Assertsions.True(true)
}

You can't travel far in testify without tripping over strange functions.

@dolmen dolmen changed the title Remove ineffective inline code blocks doc: remove ineffective inline code blocks May 25, 2025
@dolmen
Copy link
Collaborator

dolmen commented May 25, 2025

@brackendawson I would prefer that we split commits based on the {assert,require}/mock/suite package groups. Because it gives more relevant Git history. Of course this is a general rule that deserves exceptions.

In this case, the change in suite are a (good) reword of some doc, not the quotes change like elsewhere, so that would deserves being its own commit, or even its own PR.

@dolmen dolmen added enhancement documentation pkg-mock Any issues related to Mock pkg-assert Change related to package testify/assert pkg-require Change related to package testify/require pkg-suite Change related to package testify/suite labels May 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement pkg-assert Change related to package testify/assert pkg-mock Any issues related to Mock pkg-require Change related to package testify/require pkg-suite Change related to package testify/suite
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Existing docs use inline code blocks in many places
2 participants