materialsproject / public-docs

The latest documentation for the Materials Project.
https://docs.materialsproject.org
6 stars 12 forks source link

Dead links to the source codes #7

Closed e-kwsm closed 3 days ago

e-kwsm commented 10 months ago

For example, the followings in https://docs.materialsproject.org/downloading-data/using-the-api/getting-started and https://docs.materialsproject.org/downloading-data/using-the-api/querying-data#convenience-functions are dead:

The second one seemed to be https://github.com/materialsproject/api/blob/v0.33.0/mp_api/client/routes/materials.py#L53-L178 and moved to a subdirectory, https://github.com/materialsproject/api/blob/v0.34.0/mp_api/client/routes/materials/materials.py.

Also, the file linked from below has been updated since the doc was written and the range is now wrong:

which must be https://github.com/materialsproject/api/blob/1845d1ebc447dbcaa0f22dc558594575e1081721/mp_api/client/core/client.py#L1042-L1078?

Here I would suggest pinning to the commits, as shown above, instead of "main" branch.

kalvdans commented 1 month ago

Yes, please pin to the commits.

tschaume commented 3 days ago

Thanks for reporting this and your patience. I've removed the outdated links and replaced them with URLs pointing to the code documentation

kalvdans commented 2 days ago

Thanks @tschaume ! Was the changes made in 9f0dfeadfa1f5da1b6cf9838224c0f295b1f53de ?

tschaume commented 2 days ago

Yes. The changes are all reflected on https://docs.materialsproject.org.