Add documentation to composable-glsl-functions.js #28
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
Try to stick to 2 spaces for indent.
This makes the file more readable in my opinion as more context can fit on the screen at once.
See hydra.git for corresponding changes to generate the .md
documentation from this file.
This commit was generated semi automatically, like this:
1. convert docs/funcs.md to HTML using pandoc
2. parse the html using beautifulsoup4 to extract description and
example text
3. generate a sed script to modify the .js file
Some improvements to the autogenerated docs.
|
Hi, I get an error just running the initial example |
|
Fixed with 6526134 :) |
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.
The goal is to automatically generate Hydra's function documentation from this file. So, the main change is to add
descriptionandexamplefields to each of the public functions, with contents taken from hydradocs/funcs.md.I did some reformatting too as I was finding the file hard to work with -- mainly trying to normalize indent, and increase the amount of content that can fit on the screen at once by removing some line breaks.