Doc updates #14999
Merged
Doc updates #14999
Conversation
This file contains 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
|
📦 Preview the website for this branch here: https://deploy-preview-14999--ol-site.netlify.app/. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently, comments with
@fileoverview(or@file) get ignored (they end upundocumented: truedue to the api plugin). If a comment with@fileoverviewis given an@apitag, the comment is included inline in the index page (we concatenate allfiletype tags with the index docs).Since we don't currently use the
@fileoverviewand@apitag combo anywhere, I repurposed this to serve as a way to add a description for a module.In this branch, I've also updated the templates so the table for typedefs looks more like the table for constructor options.
I've updated the docs for the
ol/style/flat.jsmodule to demonstrate the change. Here is an animation of the before/after change (after has the module description, example, and typedef table changes).