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

fix(docs): fix <caption> tag rendering in Key doc #439

Merged
merged 1 commit into from
Jun 13, 2019

Conversation

jkwlui
Copy link
Member

@jkwlui jkwlui commented Jun 13, 2019

<caption> tag is being rendered out inside the code block.

link

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jun 13, 2019
@jkwlui jkwlui requested a review from a team June 13, 2019 17:11
@codecov
Copy link

codecov bot commented Jun 13, 2019

Codecov Report

Merging #439 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #439   +/-   ##
=======================================
  Coverage   98.05%   98.05%           
=======================================
  Files           5        5           
  Lines         617      617           
  Branches      145      145           
=======================================
  Hits          605      605           
  Partials       12       12
Impacted Files Coverage Δ
src/entity.ts 98.13% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 278c1c5...4f763d6. Read the comment docs.

@callmehiphop
Copy link
Contributor

@jkwlui I think the reason is that <caption> tags have to be on the same line as the @example tag. Anything that comes in after on a newline is considered the example

@JustinBeckwith JustinBeckwith merged commit 2edd95c into master Jun 13, 2019
Copy link
Contributor

@bcoe bcoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a little late to the party 😛

@stephenplusplus stephenplusplus deleted the fix-caption branch October 22, 2019 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants