Closed
Add comprehensive documentation for units feature#243
Conversation
Co-authored-by: lmmentel <8989838+lmmentel@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Create a pull request addressing the issue @lmmentel/mendeleev/issues/242
Add comprehensive documentation for units feature
Sep 16, 2025
Copilot stopped work on behalf of
lmmentel due to an error
September 16, 2025 19:57
Owner
|
This work has been superseded by PR #248, which addresses issue #242 with:
PR #248 will close #242 on merge. This PR (#243) can be closed. |
Owner
|
implemented in #248 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses issue #242 by adding comprehensive documentation for the units feature that was implemented in PR #239.
Overview
The
mendeleevpackage now supports accessing physical properties with proper units using the Pint library. Users can append_uto any property name to get aQuantityobject with units attached, enabling safer calculations and easy unit conversions.Example Usage
Documentation Added
1. Comprehensive Reference (
docs/source/data_access.rst)2. Interactive Tutorial (
docs/source/notebooks/working_with_units.ipynb)3. Quick Reference (
docs/source/quick.rst)Properties with Units Support
The documentation covers all supported properties including:
Element properties: atomic_weight, density, melting_point, boiling_point, atomic_radius, covalent_radius_, vdw_radius_, abundance_*, electron_affinity, dipole_polarizability, thermal_conductivity, and many more.
Other classes: IonicRadius (ionic_radius, crystal_radius, charge), IonizationEnergy (ionization_energy, uncertainty), Isotope (mass, quadrupole_moment), and others.
Testing
All documented examples have been thoroughly tested to ensure they work correctly, including:
This completes the TODO item from PR #239 and provides users with comprehensive guidance on using the units feature.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.