Skip to content
This repository was archived by the owner on Sep 8, 2023. It is now read-only.

Documentation for the apiens library#9

Open
kolypto wants to merge 5 commits into
dignio:masterfrom
kolypto:kaizen/2022-09-08-Promised-documentation
Open

Documentation for the apiens library#9
kolypto wants to merge 5 commits into
dignio:masterfrom
kolypto:kaizen/2022-09-08-Promised-documentation

Conversation

@kolypto

@kolypto kolypto commented Sep 8, 2022

Copy link
Copy Markdown
  • Added many comments to docstrings
  • Created a demo app to show how this library works in a real app
  • Provided the README file that guides the user through the library and shows how to build apps with it

Some tools are still not documented in the README, but the most essential parts are there

Review style: commit by commit

Because I cannot use untested code in README.md,
here's an application that provides the source
for all examples in the README.

It also has unit-tests.
Yes, we will have a unit-tested README.
Documentation for the library.
It uses examples from the misc/readme-app. Unit-tested.
@kolypto

kolypto commented Nov 4, 2022

Copy link
Copy Markdown
Author

PR #10 takes one file from this PR (namely, README.md) and pushes this to master.
Other changes were not included: e.g. improved docstrings. This PR is still relevant.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant