Clean up API documentation #559
Merged
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
- Fix links to examples in README.md - Add graph-descriptors.ipynb to notebooks in documentation - Fix maths in two_point_stats and correlations_multiple - Add more useful documentation for coeff_to_real
- Add complete documentation for solve_fe - Add complete documentation for solve_cahn_hilliard - Small changes to other API functions
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
plot_microstructures now returns the fig object, but we don't want being rendered in the notebook so using a ";" to prevent it.
|
@beyucel @auag92 please look at the new API docs to review this. There is plenty more to add to the API documentation and lots of ways to improve it. Check that there are no glaring issues and try and document anything else you notice in issues. Also, there is now a reviewnb link above which allows you to review notebooks and those reviews will get posted here. |
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.
No description provided.