Add DOI for Heybrock et al. 2023 paper in docstrings/comments
Open
Beginner friendly
Nobody has claimed this yet.
ess-legacy-v2
- Dominant language
- Python
- Stars
- 1
- Forks
- 3
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 17
Description
Places where the reference needs to be updated:
src/ess/reflectometry/corrections.pysrc/ess/sans/normalization.pysrc/ess/sans/i_of_q.pysrc/ess/uncertainty.pydocs/instruments/loki/sans2d_to_I_of_Q.ipynbdocs/instruments/external/powgen/powgen_reduction.ipynb
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by searching for the Heybrock et al. 2023 reference in src/ess/reflectometry/corrections.py, src/ess/sans/normalization.py, src/ess/sans/i_of_q.py, src/ess/uncertainty.py, and the two listed notebooks. Update each docstring or comment with the DOI, then inspect all six files to confirm the reference is present and consistently formatted.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 62/100