Title: Document electrical conductivity units by pruthvirajgojare-source · Pull Request #87 · S-AI-Projects/TheAlgorithms-Python · GitHub
Open Graph Title: Document electrical conductivity units by pruthvirajgojare-source · Pull Request #87 · S-AI-Projects/TheAlgorithms-Python
X Title: Document electrical conductivity units by pruthvirajgojare-source · Pull Request #87 · S-AI-Projects/TheAlgorithms-Python
Description: Description Added the requested formula, units, and reference to the electrical-conductivity module documentation, plus an explainer with a hand-worked calculation, dimensional-analysis table for all three solve-for cases, and decision diagram. This clarifies how to use the existing function without changing its behavior. Related Issue Not applicable; no related issue was specified. Fixes: Not applicable. Type of Change Bug Fix New Feature UI/UX Improvement Performance Improvement Tests Documentation Refactoring / Maintenance CI/CD Changes Made Documented σ = n·q·μ in the module docstring, including units for conductivity (S/m), electron concentration (m⁻³), electron charge (C), and mobility (m²/(V·s)), with a reference link. Added work/R23-T044/EXPLAINER.md, including the idea, a manually re-derived doctest example, the unit-check table for conductivity/concentration/mobility, and a decision diagram. Preserved all eight existing doctest examples and the four existing ValueError paths without code behavior changes. Screenshots / Recordings Not applicable; this is a documentation-only change with no UI. Testing uv run pytest electronics/electric_conductivity.py — passed (1 passed; the file's doctests are included). uvx ruff check electronics/electric_conductivity.py — passed. git diff --check — passed. Checklist I have tested my changes locally. I have added or updated tests, if needed. (No test changes were needed for this documentation-only update.) I have updated documentation, if needed. I have followed the project's coding guidelines. I have run the relevant tests and checks. I have addressed previous review feedback, if applicable. (No prior review feedback.) Additional Notes The units experiment gives S/m, m⁻³, and m²/(V·s) for the three respective unknowns. The worked example derives n = 5.201506356240767e+18 m⁻³ for conductivity=1000 and mobility=1200. Classmate re-derivation feedback is still pending; it has not been fabricated. Instructor review has not yet been requested because no instructor GitHub username was provided. Describe your change Add an algorithm? Fix a bug or typo in an existing algorithm? Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request. Documentation change? Checklist I have read CONTRIBUTING.md. This pull request is all my own work -- I have not plagiarized. I know that pull requests will not be merged if they fail the automated tests. This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms. (The assignment requires the explainer evidence in work/ in this same PR.) All new Python files are placed inside an existing directory. All filenames are in all lowercase characters with no spaces or dashes. (The required evidence file is named EXPLAINER.md.) All functions and variable names follow Python naming conventions. All function parameters and return values are annotated with Python type hints. All functions have doctests that pass the automated testing. All new algorithms include at least one URL that points to Wikipedia or another similar explanation. (No new algorithm was added.) If this pull request resolves one or more open issues, then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER". (No issue applies.)
Open Graph Description: Description Added the requested formula, units, and reference to the electrical-conductivity module documentation, plus an explainer with a hand-worked calculation, dimensional-analysis table for a...
X Description: Description Added the requested formula, units, and reference to the electrical-conductivity module documentation, plus an explainer with a hand-worked calculation, dimensional-analysis table for a...
Opengraph URL: https://github.com/S-AI-Projects/TheAlgorithms-Python/pull/87
X: @github
Domain: github.com
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:96151700-c79a-211a-6d53-ab2c455298cc |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | D622:1F2C95:2EB82B:4249A3:6AFE05DC |
| html-safe-nonce | 2887bad05ae36a987c4b0bae604c5fe324d5b5845cbab1b7cb2148d08d2eb173 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJENjIyOjFGMkM5NToyRUI4MkI6NDI0OUEzOjZBRkUwNURDIiwidmlzaXRvcl9pZCI6IjMwODc0NzAwOTQ3Mjk0Nzk2NDQiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | a085c6ea1723eaafbf12139211c7cce8d6960c1b7541d5883d2b5f08223d41b3 |
| hovercard-subject-tag | pull_request:5363144463 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/S-AI-Projects/TheAlgorithms-Python/pull/87/files |
| twitter:image | https://avatars.githubusercontent.com/u/295325153?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/295325153?s=400&v=4 |
| og:image:alt | Description Added the requested formula, units, and reference to the electrical-conductivity module documentation, plus an explainer with a hand-worked calculation, dimensional-analysis table for a... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 86d46ece7c3d9b0562692f81a135cb55ad6a1c82c93ab1ac874d2f1b46b28958 |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/S-AI-Projects/TheAlgorithms-Python git https://github.com/S-AI-Projects/TheAlgorithms-Python.git |
| octolytics-dimension-user_id | 351892385 |
| octolytics-dimension-user_login | S-AI-Projects |
| octolytics-dimension-repository_id | 1444141022 |
| octolytics-dimension-repository_nwo | S-AI-Projects/TheAlgorithms-Python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | true |
| octolytics-dimension-repository_parent_id | 63476337 |
| octolytics-dimension-repository_parent_nwo | TheAlgorithms/Python |
| octolytics-dimension-repository_network_root_id | 63476337 |
| octolytics-dimension-repository_network_root_nwo | TheAlgorithms/Python |
| turbo-body-classes | logged-out env-production page-responsive full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 5c18e6799976b7bc2f21178024289bb98edbcc85 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width