Clean up the LPdiag tool
Open
Nobody has claimed this yet.
enh
- Dominant language
- Jupyter Notebook
- Stars
- 150
- Forks
- 178
- Avg merge
- 17h 32m
- Merged PRs (30d)
- 2
Description
As described by @khaeru here, there are some small improvements to the LPdiag tool that we can make and should not forget about:
- Copy-edit the docs page. There are several small enhancements that could be made, like using Sphinx roles instead of double-backtick in many places, and improving the clarity of text about the locations of files. In particular, the command no longer needs to be run in any particular directory as long as the user gives valid values for --wdir and --mps.
- Define, type, and comment the class attributes of LPdiag outside of the
__init__()method so they appear in the docs; use that method only for setting defaults.
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 with the LPdiag tool and its documentation page. Review the --wdir and --mps usage text, then inspect the LPdiag class and its init() method; done means the docs are clearer and the class attributes are defined, typed, and commented outside init().
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100