Content-Length: 258946 | pFad | https://github.com/simpeg/simpeg/pull/1234

8F General Doc cleanup by jcapriot · Pull Request #1234 · simpeg/simpeg · GitHub
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

General Doc cleanup #1234

Merged
merged 5 commits into from
Jun 6, 2023
Merged

General Doc cleanup #1234

merged 5 commits into from
Jun 6, 2023

Conversation

jcapriot
Copy link
Member

@jcapriot jcapriot commented Jun 6, 2023

Summary

Cleans up a few documentation pages.

PR Checklist

  • If this is a work in progress PR, set as a Draft PR
  • Linted my code according to the style guides.
  • Added tests to verify changes to the code.
  • Added necessary documentation to any new functions/classes following the
    expect style.
  • Added relevant method tags (i.e. GRAV, EM, etc.)
  • Marked as ready for review (ff this is was a draft PR), and converted
    to a Pull Request
  • Tagged @simpeg/simpeg-developers when ready for review.

What does this implement/fix?

Removes duplicate documentation of utilities imported from discretize. Also cleans up a few other small documentation errors.

@codecov
Copy link

codecov bot commented Jun 6, 2023 •
edited
Loading

Codecov Report

Merging #1234 (3f079d9) into main (fb26cea) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1234   +/-   ##
=======================================
  Coverage   82.14%   82.15%           
=======================================
  Files         163      163           
  Lines       24680    24680           
=======================================
+ Hits        20274    20275    +1     
+ Misses       4406     4405    -1
Impacted Files Coverage Δ
SimPEG/electromagnetics/__init__.py 100.00% <ø> (ø)
SimPEG/electromagnetics/analytics/FDEM.py 85.32% <ø> (ø)
...magnetics/static/spontaneous_potential/__init__.py 100.00% <ø> (ø)
SimPEG/fields.py 96.47% <ø> (ø)
SimPEG/potential_fields/gravity/__init__.py 100.00% <ø> (ø)
SimPEG/regularization/__init__.py 95.12% <ø> (ø)
SimPEG/regularization/base.py 94.73% <ø> (ø)
SimPEG/utils/__init__.py 100.00% <ø> (ø)
SimPEG/utils/io_utils/io_utils_pf.py 96.61% <ø> (ø)
SimPEG/utils/code_utils.py 80.54% <100.00%> (+0.24%) ⬆️
... and 1 more

@jcapriot jcapriot merged commit 23b91ba into simpeg:main Jun 6, 2023
@jcapriot jcapriot deleted the doc_cleanup branch June 6, 2023 22:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@jcapriot








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: https://github.com/simpeg/simpeg/pull/1234

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy