search

materialsproject / api

New API client for the Materials Project
https://materialsproject.github.io/api/
Other
108 stars 40 forks source link

Fix rendering of MPRester docstring in deployed docs #863

Closed ml-evs closed 7 months ago

ml-evs commented 10 months ago

It looks like ruff was a bit too rough with this docstring in https://github.com/materialsproject/api/pull/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 for s3_resource and mute_progress_bars as best I could.

I haven't tried building the docs locally but 99% sure this will work.

ml-evs commented 7 months ago

Any chance this could be merged? The online docs are still pretty unreadable. Tagging @munrojm as the most recent contributor here

munrojm commented 7 months ago

@ml-evs yup! Merging now. Sorry this got looked over.