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

Added a warning admonition to the list of dependencies in the installation guide #4706

Merged
merged 3 commits into from
Dec 22, 2024

Conversation

RohitP2005
Copy link
Contributor

Description

This PR adds a warning admonition in the documentation to notify users about potentially outdated dependencies listed in the requirements section. The change helps to ensure that users are aware that the dependencies listed may not be up-to-date and should be verified.

Fixes #4705

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • Documentation update (non-breaking change that modifies documentation)
  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python -m pytest (or $ nox -s tests)
  • The documentation builds: $ python -m pytest --doctest-plus src (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works
    PyBaMM

docs/source/user_guide/installation/index.rst Outdated Show resolved Hide resolved
Copy link

codecov bot commented Dec 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.22%. Comparing base (a7253b8) to head (ad50448).
Report is 4 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4706   +/-   ##
========================================
  Coverage    99.22%   99.22%           
========================================
  Files          303      303           
  Lines        23070    23077    +7     
========================================
+ Hits         22891    22898    +7     
  Misses         179      179           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @RohitP2005!

@agriyakhetarpal agriyakhetarpal changed the title Added a warning admonition in docs Added a warning admonition to the list of dependencies in the installation guide Dec 22, 2024
@agriyakhetarpal agriyakhetarpal merged commit ef7675d into pybamm-team:develop Dec 22, 2024
24 checks passed
@RohitP2005 RohitP2005 deleted the issue#4705 branch December 22, 2024 17:08
@RohitP2005
Copy link
Contributor Author

Thanks, @RohitP2005!

Pleasure working with you

@@ -45,6 +45,10 @@ Dependencies
------------
.. _install.required_dependencies:

.. warning::

The list of dependencies below might be outdated. Please refer to the ``pyproject.toml`` file to find all dependencies.
Copy link
Member

@Saransh-cpp Saransh-cpp Dec 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This assumes that users know what pyproject.toml is (without a link) 😢

Suggested change
The list of dependencies below might be outdated. Please refer to the ``pyproject.toml`` file to find all dependencies.
The list of dependencies below might be outdated. Please use tools like [``pipdeptree``](https://github.com/tox-dev/pipdeptree) to find the latest dependencies of ``pybamm``.

@RohitP2005 can you fix this in a new PR if @agriyakhetarpal agrees?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I thought about leaving a permalink to the file, but dropped the idea considering that most users wouldn't require to see it and it might get outdated as well. On second thought, please feel free to add a link to it from the main branch, because it's unlikely that the file's location will change, and if it does, it will be noticed caught by improvements like #4686 anyway.

Also, pipdeptree does not yet display optional dependencies properly (and neither does uv pip tree), so I wouldn't recommend adding it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, i agree with @agriyakhetarpal

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! @RohitP2005 could you open a PR adding the link?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Saransh-cpp Sorry for the confusion earlier as I was misguided by this comment #4706 (comment) . I have added link to the pyproject.toml file as u requested

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

Successfully merging this pull request may close these issues.

Add a warning to the list of dependencies in the docs.
4 participants