Skip to content

Docs: use markdown headings instead of links for API declarations #33381

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

Merged
oandregal merged 6 commits into from
Jul 14, 2021
Merged

Docs: use markdown headings instead of links for API declarations #33381

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
284c040
symbol name as proper heading level 2
juanmaguitar Jul 12, 2021
10b97d2
Merge branch 'WordPress:trunk' into docgen-fix-heading-symbol
juanmaguitar Jul 13, 2021
32245fd
Merge branch 'WordPress:trunk' into docgen-fix-heading-symbol
juanmaguitar Jul 13, 2021
511339b
added generated md w/ proper headings for symbol names
juanmaguitar Jul 13, 2021
fb2f09f
modified test to include change in formatter
juanmaguitar Jul 13, 2021
8d6272b
removed coverage folder
juanmaguitar Jul 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
modified test to include change in formatter
  • Loading branch information
@juanmaguitar
juanmaguitar committed Jul 13, 2021
commit fb2f09f33c171e15cfb7f770b77408b2f6f21d8c
2 changes: 1 addition & 1 deletion packages/docgen/test/formatter-markdown.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ describe( 'Formatter', () => {
'API docs'
);
expect( docs ).toBe(
'# API docs\n\n<a name="myDeclaration" href="#myDeclaration">#</a> **myDeclaration**\n\nMy declaration example.\n\n*Parameters*\n\n- *firstParam* `number`: First declaration parameter.\n\n*Returns*\n\n- `number`: The result of the declaration.\n'
'# API docs\n\n## myDeclaration\n\nMy declaration example.\n\n*Parameters*\n\n- *firstParam* `number`: First declaration parameter.\n\n*Returns*\n\n- `number`: The result of the declaration.\n'
);
} );
} );