-
Notifications
You must be signed in to change notification settings - Fork 473
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
Use application registry in docs #1275
base: master
Are you sure you want to change the base?
Conversation
The application registry feature is not adequately advertised. Improve this by using get_application_registry() instead of UnitRegistry() throughout the docs (including README and docstrings) when that makes sense. Also change the tutorial to recommend using it whenever possible. See hgrecco#1273 for the motivation.
Hi, I am still getting some doctest errors, but I am not sure if they are related to my changes. |
I am not sure that putting What I already know is that we should improve the correspondending subsection (or even move it to its own section). This should include the rationale that I gave in #1273 and maybe a small example (e.g. project 1, project 2 ..). If we put a new section, we could also link to wraps aand check and other things that allow pint to play well with others. Going back to the readme and docs, my fear is that we are changing the suggested way to use it too quickly and confuse existing users. My suggestions would be to do a gradual rollout. Example: we put the |
I completely defer it to your judgement, @hgrecco since I have only a very biased perspective on the use of pint. I created this PR just because it was simpler than trying to explain my proposed changes, but I don't mind at all if it is partially or completely edited. My point of view: I like the "radical" change (as proposed) because the full benefit of the application registry comes, IMHO, when its use is generalized (i.e. when most pint-enabled projects play along well with the rest) |
The application registry feature is not adequately advertised.
Improve this by using get_application_registry() instead of UnitRegistry()
throughout the docs (including README and docstrings) when that makes sense.
Also change the tutorial to recommend using it whenever possible.
See #1273 for the motivation.
pre-commit run --all-files
with no errors