Improve filters and directives documentation rendering. #2
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
added 3 commits
March 17, 2014 18:06
If parameters are defined for the filter, use the first one as the input expression in the example.
Do not use `shortName` in the example but the last part of the `id`. This allows human-readable names in the directives list (left column) while still having correct examples.
…ngular templates.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Hi there!
I'm new with Docular, and I find it great! The output documentation is really nice, and it's now a pleasure to document my directives, filters and services!
I've changed a few things to improve the rendering for filters and directives.
id(instead of itsshortName) to generate the sample code. This allows a human readable name (within@name) while still having a correct example. (Human readable names really look nicer in the directives list in the left column!)Can you have a look at this pull request and give me feedback?
Thank you very much for your answer and for this great project!