This repository was archived by the owner on Apr 12, 2024. It is now read-only.
chore(doc-gen): render @example tag for ngdoc @method #15448
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently, ngdoc `@method` ignores `@example` tags and does not output them. This is usually not a problem, as examples are mostly defined directly in the `@description` via code blocks or `<example>` elements. However, some methods still have `@example` tags (possibly from a previous docs version). While not absolutely necessary, having special markup for Examples makes them a) easier to find visually in the docs, and b) easier to link to as they will have a unique id. Closes angular#14722
Narretz
force-pushed
the
docs-method-examples
branch
from
93ad990 to
a0a71ab
Compare
Narretz
commented
Nov 29, 2016
| @@ -51,7 +51,7 @@ <h2 id="dependencies">Dependencies</h2> | |||
|
|
|||
| {% block examples %} | |||
| {%- if doc.examples %} | |||
| <h2 id="example">Example</h2> | |||
| <h2 id="example">Examples</h2> | |||
There was a problem hiding this comment.
I've changes this because all of our headlines are plural, even if there's only one member (Parameters, Methods). I didn't change the id to not break any links.
gkalpak
approved these changes
Dec 1, 2016
Narretz
added a commit
that referenced
this pull request
Dec 2, 2016
Currently, ngdoc `@method` ignores `@example` tags and does not output them. This is usually not a problem, as examples are mostly defined directly in the `@description` via code blocks or `<example>` elements. However, some methods still have `@example` tags (possibly from a previous docs version). While not absolutely necessary, having special markup for Examples makes them a) easier to find visually in the docs, and b) easier to link to as they will have a unique id. Closes #14722 Closes #15448
ellimist
pushed a commit
to ellimist/angular.js
that referenced
this pull request
Mar 15, 2017
Currently, ngdoc `@method` ignores `@example` tags and does not output them. This is usually not a problem, as examples are mostly defined directly in the `@description` via code blocks or `<example>` elements. However, some methods still have `@example` tags (possibly from a previous docs version). While not absolutely necessary, having special markup for Examples makes them a) easier to find visually in the docs, and b) easier to link to as they will have a unique id. Closes angular#14722 Closes angular#15448
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
feat / fix to the docs app
What is the current behavior? (You can also link to an open issue here)
@examplein@methodis not renderedDoes this PR introduce a breaking change?
No
Please check if the PR fulfills these requirements