Skip to content

Added docs in OKF format#79

Merged
zsimic merged 5 commits into
mainfrom
added-okf-docs
Jun 23, 2026
Merged

Added docs in OKF format#79
zsimic merged 5 commits into
mainfrom
added-okf-docs

Conversation

@zsimic

@zsimic zsimic commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

@coveralls

coveralls commented Jun 23, 2026

Copy link
Copy Markdown

Coverage Report for CI Build 28056019167

Coverage remained the same at 98.476%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 2690
Covered Lines: 2649
Line Coverage: 98.48%
Coverage Strength: 4.92 hits per line

💛 - Coveralls

Comment thread docs/architecture/build-setup.md Outdated

# Citations

[1] [src/portable_python/__init__.py — BuildSetup](https://github.com/codrsquad/portable-python/blob/main/src/portable_python/__init__.py)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Is this meant to be referred to from somewhere?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Removed all citations now 👍 they were indeed all superfluous

@@ -0,0 +1,51 @@
---
type: Class

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Why is a page about a class better than a docstring in the code? How do we decide what to put where?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good point! Rephrased everything to avoid repeating anything from code

@zsimic zsimic merged commit a002d16 into main Jun 23, 2026
7 checks passed
@zsimic zsimic deleted the added-okf-docs branch June 23, 2026 20:49
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