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

Clean up the LPdiag tool #763

Open
2 tasks
glatterf42 opened this issue Nov 30, 2023 · 2 comments
Open
2 tasks

Clean up the LPdiag tool #763

glatterf42 opened this issue Nov 30, 2023 · 2 comments
Labels
enh New features & functionality

Comments

@glatterf42
Copy link
Member

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.
@glatterf42 glatterf42 added the enh New features & functionality label Nov 30, 2023
@macflo8
Copy link

macflo8 commented Dec 6, 2023

I would like to add a minor thing that I discovered yesterday:

The default value of the --up-tail click_option passed to the lp-diag tool is set to -5. The help string says that it is set to 5. It seems that the minus slipped in there.

@glatterf42
Copy link
Member Author

Thanks for pointing this out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enh New features & functionality
Projects
None yet
Development

No branches or pull requests

2 participants