Add documentation page for Transforms #17
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
Author
|
If I understands correctly the way all OwnTech docs are aggregated, I guess that a coordinated addition needs to be done in one of the mkdocs.yml file of https://github.com/owntech-foundation/Documentation/ |
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.
Hello OwnTech,
This PR adds one page for documenting the code of the three-phase transforms from transform.h and transform.cpp.
Notice that it doesn't include a detailed nice explanation/course of what are these transforms. That's left for a potential future revision. However, I think it does a reasonable job of documenting the Transform API.
Let me know what you think!