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

Improve documentation for html under Formats #163

Closed
geraldfullam opened this issue Jul 13, 2018 · 1 comment
Closed

Improve documentation for html under Formats #163

geraldfullam opened this issue Jul 13, 2018 · 1 comment

Comments

@geraldfullam
Copy link
Contributor

I discovered through trial that when using theo to build html that some categories of tokens were not rendered to the page. Upon examining the source code, I learned that these categories are conditionally rendered and that each is mapped to a human-friendly display name.

I propose mentioning this conditional rendering and explicitly listing the supported categories and their mapped display names (and perhaps in the future making this configurable via options).

Also, the comment in the example for passing additional options for the html format implies that there are more than just the one transformPropName shown, but upon examining the source code it appears that this is the only additional configurable option at this time.

I propose explicitly listing the configurable option(s) in the documentation.

@aputinski
Copy link
Contributor

I totally agree. Would you mind submitting a PR?

geraldfullam pushed a commit to geraldfullam/theo that referenced this issue Jul 16, 2018
…egories and their mapped display names as well as explicitly listing the configurable option(s) in the documentation.
geraldfullam pushed a commit to geraldfullam/theo that referenced this issue Jul 16, 2018
…egories and their mapped display names as well as explicitly listing the configurable option(s) in the documentation.
aputinski added a commit that referenced this issue Jul 16, 2018
…html-format

Fixes issue #163: Improve documentation for `html` under Formats
abalmus pushed a commit to abalmus/theo that referenced this issue Jul 24, 2018
…egories and their mapped display names as well as explicitly listing the configurable option(s) in the documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants