Fix rendering of MPRester docstring in deployed docs #863
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
|
Any chance this could be merged? The online docs are still pretty unreadable. Tagging @munrojm as the most recent contributor here |
3 tasks
|
@ml-evs yup! Merging now. Sorry this got looked over. |
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.
It looks like ruff was a bit too rough with this docstring in #772, which messes up the rendered API docs for this class (see
__init__and class docstring at https://materialsproject.github.io/api/_autosummary/mp_api.client.mprester.MPRester.html). This PR fixes it by adding a throwaway line at the top and then follows the appropriate docstring format (feel free to edit the content itself), I also added entries fors3_resourceandmute_progress_barsas best I could.I haven't tried building the docs locally but 99% sure this will work.