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

Add space before backquote #10918

Merged
merged 1 commit into from
Aug 23, 2023
Merged

Conversation

greg0ire
Copy link
Member

According to the RST docs,

[inline markup] it must be separated from surrounding text by non-word
characters. Use a backslash escaped space to work around that: thisis\ one\ word.

Because we were missing a space before backquotes here, the links were not rendered. Escaping the space allow not to actually produce a space in the output.

See https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#inline-markup

According to the RST docs,

> [inline markup] it must be separated from surrounding text by non-word
> characters. Use a backslash escaped space to work around that: thisis\ *one*\ word.

Because we were missing a space before backquotes here, the links were
not rendered. Escaping the space allow not to actually produce a space
in the output.

See https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#inline-markup
@greg0ire
Copy link
Member Author

Note that although doctrine/rst-parser cares about this, the Parser used by Github does not seem to care, hence, no diff.

@greg0ire
Copy link
Member Author

Thanks @linawolf for the solution!

@SenseException SenseException merged commit 3a8cafe into doctrine:2.16.x Aug 23, 2023
@greg0ire greg0ire deleted the fix-links-markup branch August 23, 2023 20:08
derrabus added a commit that referenced this pull request Aug 23, 2023
* 2.16.x:
  Use required classes for Lifecycle Callback examples (#10916)
  Add space before backquote (#10918)
  Add back throws annotation to getSingleScalarResult (#10907)
  Fix link on known issues docs (#10904)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants