Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: Update API reference to use simpeg instead of SimPEG? #1437

Closed
santisoler opened this issue Apr 26, 2024 · 2 comments · Fixed by #1446
Closed

DOC: Update API reference to use simpeg instead of SimPEG? #1437

santisoler opened this issue Apr 26, 2024 · 2 comments · Fixed by #1446

Comments

@santisoler
Copy link
Member

santisoler commented Apr 26, 2024 •
edited
Loading

Issue with current documentation:

After #1430 was merged, we deprecated the SimPEG package in favor for its pep8 compliant name: simpeg.

I noticed that we haven't applied any changes to the API reference, and SimPEG is still being used there. See for example: https://github.com/simpeg/simpeg/tree/main/docs/content/api

Idea or request for content:

Shall we update the API reference to use simpeg instead?
@santisoler
Copy link
Member Author

cc @jcapriot

@jcapriot
Copy link
Member

Yeah, should change them all to be simpeg (and make sure we update the automodule calls in them too.

@santisoler santisoler mentioned this issue Apr 26, 2024
Merged
7 tasks
@santisoler santisoler mentioned this issue May 6, 2024
Merged
6 tasks
santisoler added a commit that referenced this issue May 10, 2024
@santisoler
Replace SimPEG for simpeg in API reference (#1446)
c4b2750 
Rename rst files in `docs/content/api` and replace `SimPEG` for `simpeg`
in `docs/content/api/index.rst`.

Fixes #1437
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Replace SimPEG for simpeg in API reference simpeg/simpeg
2 participants
@santisoler @jcapriot