Repository navigation
67 write a simple documentation with examples - #71
Merged
Merged
Conversation
…umentation-with-examples
Collaborator
|
@haitao-ZCU Please incorporate the documentation into CI. Something similar to what we did in WildlifeDatasets. |
Collaborator
Author
|
Collaborator
|
@haitao-ZCU Good, two small changes, then we can merge it.
|
Collaborator
Author
|
Collaborator
|
@haitao-ZCU Sorry, one more thing. Add a link to the README for the documentation. Also, please try to be a bit proactive and come up with these things by yourself. |
Collaborator
Author
|
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
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.
A WINDING.md, including how to use compute_winding_layout (with two worked examples, 3f_36s and 5f_40s machines), the meanings of the outputs, double layer windings, and the relation to coil_pitch/belt_offset.