[Bug] Reference to pyiron units in warnings
Open
Nobody has claimed this yet.
bug
- Dominant language
- Python
- Stars
- 6
- Forks
- 5
- Avg merge
- 1h 37m
- Merged PRs (30d)
- 6
Description
We often get warnings of the form
lammpsparser/units.py:242: UserWarning: Warning: Couldn't determine the LAMMPS to pyiron unit conversion type of quantity Density. Returning un-normalized quantity
warnings.warn(
Since lammpsparser is no longer dependent on pyiron, perhaps the documentation of the lammpsparser could mention what this unit conversion does and include a reference to pyiron units.
Contributor guide
No contributing guide indexed for this repository
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 with lammpsparser/units.py:242 and trace the unit-conversion behavior behind the warning. Find the project documentation location, explain what the LAMMPS-to-pyiron unit conversion does, and add a reference to pyiron units. Done means the documentation covers this warning and its conversion context.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100