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.

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

Mention source of elements database in docstring #87

Merged
merged 4 commits into from
Sep 18, 2024

Conversation

ericpre
Copy link
Member

@ericpre ericpre commented Sep 18, 2024

As mentioned in #85 (comment).

Progress of the PR

  • Mention source of elements database in docstring,
  • docstring updated (if appropriate),
  • update user guide (if appropriate),
  • [n/a] added tests,
  • add a changelog entry in the upcoming_changes folder (see upcoming_changes/README.rst),
  • Check formatting of the changelog entry (and eventual user guide changes) in the docs/readthedocs.org:exspy build of this PR (link in github checks)
  • ready for review.

@ericpre ericpre added this to the v0.3 milestone Sep 18, 2024
@ericpre ericpre added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 18, 2024
doc/reference/material.rst Outdated Show resolved Hide resolved
Copy link

codecov bot commented Sep 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.70%. Comparing base (ee31d0a) to head (0f9d7c0).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #87   +/-   ##
=======================================
  Coverage   88.70%   88.70%           
=======================================
  Files          77       77           
  Lines        7453     7453           
  Branches     1200     1200           
=======================================
  Hits         6611     6611           
  Misses        572      572           
  Partials      270      270           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

exspy/_misc/elements.py Outdated Show resolved Hide resolved
@jlaehne
Copy link
Contributor

jlaehne commented Sep 18, 2024

Chantler reference is already mentioned in other docstrings, but way of mentioning is quite inconsistent.

@ericpre ericpre force-pushed the improve_docstring_elements_database branch from 5d9197c to 003f15a Compare September 18, 2024 14:24
@ericpre
Copy link
Member Author

ericpre commented Sep 18, 2024

Chantler reference is already mentioned in other docstrings, but way of mentioning is quite inconsistent.

@jlaehne, is it better now with the references?

exspy/_misc/elements.py Outdated Show resolved Hide resolved
doc/reference/material.rst Outdated Show resolved Hide resolved
doc/reference/material.rst Outdated Show resolved Hide resolved
exspy/_misc/elements.py Outdated Show resolved Hide resolved
@jlaehne
Copy link
Contributor

jlaehne commented Sep 18, 2024

Chantler reference is already mentioned in other docstrings, but way of mentioning is quite inconsistent.

@jlaehne, is it better now with the references?

Maybe align also the citation in the Bibliography of the User Guide (use DOI, it currently uses the subtitle and not the title of the page).

@jlaehne jlaehne merged commit 5451752 into hyperspy:main Sep 18, 2024
17 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants