Skip to content

Documentation improvements#84

Merged
everoddandeven merged 1 commit intomainfrom
improve-documentation
Apr 19, 2026
Merged

Documentation improvements#84
everoddandeven merged 1 commit intomainfrom
improve-documentation

Conversation

@everoddandeven
Copy link
Copy Markdown
Owner

@everoddandeven everoddandeven commented Apr 17, 2026

Documentation improvements

  • Improve docstrings
  • Fix typos
  • Add documentation pages
  • Update README

@codacy-production
Copy link
Copy Markdown

codacy-production bot commented Apr 17, 2026

Not up to standards ⛔

🔴 Issues 27 minor

Alerts:
⚠ 27 issues (≤ 0 issues of at least minor severity)

Results:
27 new issues

Category Results
BestPractice 23 minor
CodeStyle 4 minor

View in Codacy

🟢 Metrics -5 complexity · 0 duplication

Metric Results
Complexity -5
Duplication 0

View in Codacy

🟢 Coverage 96.70% diff coverage · +0.04% coverage variation

Metric Results
Coverage variation +0.04% coverage variation (-1.00%)
Diff coverage 96.70% diff coverage

View coverage diff in Codacy

Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (1eb313a) 17580 15699 89.30%
Head commit (c2fc97c) 17578 (-2) 15705 (+6) 89.34% (+0.04%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#84) 182 176 96.70%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

TIP This summary will be updated as you push new changes. Give us feedback

* Improve docstrings
* Fix typos
* Add documentation pages
* Update README
@everoddandeven everoddandeven force-pushed the improve-documentation branch from 4bf4762 to c2fc97c Compare April 19, 2026 15:45
@everoddandeven everoddandeven marked this pull request as ready for review April 19, 2026 15:47
@everoddandeven everoddandeven merged commit c9dde87 into main Apr 19, 2026
9 checks passed
@everoddandeven everoddandeven deleted the improve-documentation branch April 19, 2026 16:41
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.

1 participant