Repository navigation
Pruthviraj Gojare — R23-T044: Teach the idea behind electronics/electric_conductivity.py #45
Description
Student: Pruthviraj Gojare
Task: R23-T044 · 4 of 10
Repository: https://github.com/S-AI-Projects/TheAlgorithms-Python
Assigned working branch: student/e26b07f0834
Goal
Write an explanation good enough for a classmate to re-implement the algorithm, and improve the file's own documentation. Experiment: build a table checking the units of σ = n·q·μ and the three solve-for cases.
Steps
- Write work/R23-T044/EXPLAINER.md: the idea, a worked example by hand, and a diagram.
- Add or improve the module docstring with a reference link (CONTRIBUTING.md asks for one) and a one-paragraph summary.
- Carry out the experiment described in the goal and include the result.
- Ask a classmate to re-derive one doctest result from your explainer and record their feedback.
- Make the code change in the repository: electronics/electric_conductivity.py: module docstring with the formula σ = n·q·μ, units and a reference link. Re-run the automated check and the repo's own tests afterwards.
- Prepare the PR: on branch R23-T044, commit the code change plus your work/R23-T044/ evidence, put your findings in the PR description and open the PR against the org fork. For a later upstream PR, create a second branch containing only the code change (no work/ folder).
Done when
☐ electronics/electric_conductivity.py has a module docstring with σ = n·q·μ, units for each quantity and a reference.
☐ EXPLAINER.md has a unit-check table for the three solve-for cases.
☐ Existing 8 doctests and 4 raise paths unchanged.
Additional task guidance
Additional curated task guidance
Item:
electronics/electric_conductivity.py (73 lines; 8 doctests)
Task type:
Explain the algorithm
Code change (goes into the PR):
electronics/electric_conductivity.py: module docstring with the formula σ = n·q·μ, units and a reference link.
Automated check:
uv run pytest electronics/electric_conductivity.py
Prerequisites:
Linux/WSL2/Codespaces with uv (https://docs.astral.sh/uv/getting-started/installation/); run uv sync --group=test once – it installs the Python version CI uses (.python-version = 3.15t) and the test dependencies, about 1–2 GB
Upstream PR rules:
Follow CONTRIBUTING.md: type hints on every parameter/return, doctests for valid and erroneous input, snake_case file names, no duplicate of an existing implementation, no hand edits to DIRECTORY.md. CI (pytest with doctests, ruff) must pass – bots close PRs without tests or type hints. Keep work/ (benchmarks, notes, property tests) out of the upstream branch; put results in the PR description.
Source (pinned):
https://github.com/TheAlgorithms/Python/blob/574d100b7181956e9c8384552fd078165e4cc326/electronics/electric_conductivity.py
Change:
No change recorded
PR destination:
Preserved pilot guidance
Submission checklist
- Complete this task and its checks.
- Add the required evidence and link your pull request here.
- Select this S-AI-Projects fork as the PR base repository.
- Request instructor review.
Keep this PR focused on this task. Do not submit assignment PRs to the upstream repository.
Activity