Skip to content

[FrameworkBundle] Fix third level headers for MarkdownDescriptor #21324

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

Merged
merged 1 commit into from
Jan 17, 2017
Merged

[FrameworkBundle] Fix third level headers for MarkdownDescriptor #21324

merged 1 commit into from
Jan 17, 2017

Conversation

ogizanagi
Copy link
Contributor

@ogizanagi ogizanagi commented Jan 17, 2017

Q A
Branch? 2.7
Bug fix? yes
New feature? no
BC breaks? no
Deprecations? no
Tests pass? yes
Fixed tickets N/A
License MIT
Doc PR N/A

~ is not valid as an underlining char when using markdown on the contrary of reStructuredText.
See the rendering of builder_1_public.md (before) vs builder_1_public.md (after) for instance.

This PR fixes it by using a third level header.

EDIT: There is no BC break. Wrong PR template information.

@xabbuh
Copy link
Member

xabbuh commented Jan 17, 2017

👍

Status: Reviewed

@fabpot
Copy link
Member

fabpot commented Jan 17, 2017

Thank you @ogizanagi.

@fabpot fabpot merged commit ce29ab1 into symfony:2.7 Jan 17, 2017
fabpot added a commit that referenced this pull request Jan 17, 2017
…scriptor (ogizanagi)

This PR was merged into the 2.7 branch.

Discussion
----------

[FrameworkBundle] Fix third level headers for MarkdownDescriptor

| Q             | A
| ------------- | ---
| Branch?       | 2.7
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | N/A
| License       | MIT
| Doc PR        | N/A

`~` is not valid as an underlining char when using markdown on the contrary of reStructuredText.
See the rendering of [builder_1_public.md (before)](https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/builder_1_public.md)  vs [builder_1_public.md (after)](https://github.com/ogizanagi/symfony/blob/fix/2.7/fwb/md_third_lvl_headers/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/builder_1_public.md) for instance.

This PR fixes it by using a third level header.

~~**EDIT:** There is no BC break. Wrong PR template information.~~

Commits
-------

ce29ab1 [FrameworkBundle] Fix third level headers for MarkdownDescriptor
@ogizanagi ogizanagi deleted the fix/2.7/fwb/md_third_lvl_headers branch January 17, 2017 20:07
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.

5 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy