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

docs: Simplify undestanding what's going on #750

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

MaxymVlasov
Copy link
Collaborator

Description of your changes

  • Add notes for contributors
  • Describe what different parts of code does, for simplifying future maintenance if it will be needed

@MaxymVlasov MaxymVlasov requested a review from yermulnik as a code owner January 9, 2025 22:52
tox.ini Outdated Show resolved Hide resolved
@MaxymVlasov MaxymVlasov force-pushed the chore/imporve_python_tooling_docs branch from 5a84944 to 71886dc Compare January 9, 2025 23:00
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/workflows/reusable-tox.yml Outdated Show resolved Hide resolved
pytest.ini Outdated Show resolved Hide resolved
tox.ini Outdated Show resolved Hide resolved
tox.ini Outdated Show resolved Hide resolved
MaxymVlasov and others added 2 commits January 10, 2025 01:48
Co-authored-by: George L. Yermulnik <[email protected]>
Co-authored-by: George L. Yermulnik <[email protected]>
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
tox.ini Outdated Show resolved Hide resolved
tox.ini Outdated Show resolved Hide resolved
tox.ini Outdated Show resolved Hide resolved
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.38%. Comparing base (976cef3) to head (e5948c3).

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #750   +/-   ##
=======================================
  Coverage   96.38%   96.38%           
=======================================
  Files          10       10           
  Lines         249      249           
  Branches        7        7           
=======================================
  Hits          240      240           
  Misses          9        9           
Flag Coverage Δ
CI-GHA 96.38% <ø> (ø)
MyPy 91.05% <ø> (ø)
OS-Linux 96.38% <ø> (ø)
OS-Windows 100.00% <ø> (ø)
OS-macOS 100.00% <ø> (ø)
Py-3.10.11 100.00% <ø> (ø)
Py-3.10.16 100.00% <ø> (ø)
Py-3.11.11 100.00% <ø> (ø)
Py-3.11.9 100.00% <ø> (ø)
Py-3.12.8 100.00% <ø> (ø)
Py-3.13.1 96.38% <ø> (ø)
Py-3.9.13 100.00% <ø> (ø)
Py-3.9.21 100.00% <ø> (ø)
VM-macos-13 100.00% <ø> (ø)
VM-macos-14 100.00% <ø> (ø)
VM-ubuntu-24.04 100.00% <ø> (ø)
VM-ubuntu-latest 91.05% <ø> (ø)
VM-windows-2025 100.00% <ø> (ø)
pytest 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link
Collaborator

@yermulnik yermulnik left a comment

Choose a reason for hiding this comment

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

@webknjaz Please shout out before @MaxymVlasov has this merged as I'm approving with the belief that you're keeping an eye on it 🤝

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
pytest.ini Outdated Show resolved Hide resolved
MaxymVlasov and others added 4 commits January 15, 2025 12:54
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
@MaxymVlasov MaxymVlasov requested a review from webknjaz January 15, 2025 11:03
Copy link
Contributor

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

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

good enough

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.

3 participants