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

Markdown generator does not output headings correctly #2967

Merged
merged 1 commit into from
Aug 10, 2020
Merged

Markdown generator does not output headings correctly #2967

merged 1 commit into from
Aug 10, 2020

Conversation

o5
Copy link
Contributor

@o5 o5 commented May 22, 2020

Before

before

After

after

Tested in GitHub, GitLab, Bitbucket and PHPStorm Markdown Plugin.

@o5
Copy link
Contributor Author

o5 commented Jun 2, 2020

@gsherwood Could you check it, please?

@o5
Copy link
Contributor Author

o5 commented Jul 14, 2020

@gsherwood any comments?

@gsherwood gsherwood added this to the 3.5.6 milestone Jul 14, 2020
@gsherwood gsherwood added this to Idea Bank in PHPCS v3 Development via automation Jul 14, 2020
o5 added a commit to slimapi/coding-standard that referenced this pull request Jul 17, 2020
@gsherwood
Copy link
Member

I went to merge this and realised there is a hard-coded unix newline here. The PHP_EOL constant is used throughout doc generation to ensure the newline characters match the OS being used, so this should be used for consistency.

But I realise it's been 2 months, so I can make that change if you don't have time.

@gsherwood gsherwood changed the title Generator/Markdown: Workaround for better rendering Markdown generator does not output headings correctly Aug 10, 2020
gsherwood added a commit that referenced this pull request Aug 10, 2020
@gsherwood gsherwood merged commit c9bbba6 into squizlabs:master Aug 10, 2020
PHPCS v3 Development automation moved this from Idea Bank to Ready for Release Aug 10, 2020
@gsherwood
Copy link
Member

Thanks a lot for that change, and for this fix.

@o5 o5 deleted the fix-generator-md branch September 2, 2020 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
PHPCS v3 Development
Ready for Release
Development

Successfully merging this pull request may close these issues.

None yet

3 participants