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.

Sign up for GitHub

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

Jump to bottom

Test Documentation with doctest - Usage guide is broken for version 1.x #264

Closed
cleder opened this issue Nov 2, 2023 · 2 comments · Fixed by #336
Closed

Test Documentation with doctest - Usage guide is broken for version 1.x #264

cleder opened this issue Nov 2, 2023 · 2 comments · Fixed by #336
Labels
bug documentation
Milestone
Version 1.0

Comments

@cleder
Copy link
Owner

cleder commented Nov 2, 2023

The examples in the Usage guide are no longer working with version 1.0 -> #100

This is because the syntax is still python 2 and that the API has changed from version 0.x to 1.x.

Test the documentation with doctest

cd docs
make html
python -m doctest -v _build/html/_sources/usage_guide.rst.txt

...
1 items had failures:
  14 of  32 in usage_guide.rst.txt
32 tests in 1 items.
18 passed and 14 failed.
***Test Failed*** 14 failures.

Todo:

  1. Update python syntax to python 3
  2. Fix the failing test for the new API
  3. Run the doctests in GitHub action
@cleder
Copy link
Owner Author

cleder commented Nov 2, 2023 •
edited
Loading

Work on Branch

@cleder cleder mentioned this issue Nov 2, 2023
Closed
@cleder cleder added this to FastKML Nov 2, 2023
@cleder cleder moved this to Todo in FastKML Nov 2, 2023
@cleder cleder added this to the Version 1.0 milestone Dec 2, 2023
@cleder
Copy link
Owner Author

cleder commented Dec 11, 2023 •
edited
Loading

https://www.b-list.org/weblog/2023/dec/10/python-doctest/
https://abstraction.blog/2023/11/22/intuitive-documentation-strategy

cleder added a commit that referenced this issue Apr 20, 2024
@cleder
fix code in documentation, run doctests on CI, #264
14c2183
@cleder cleder closed this as completed Apr 20, 2024
@github-project-automation github-project-automation bot moved this from Todo to Done in FastKML Apr 20, 2024
@cleder cleder linked a pull request Jul 18, 2024 that will close this issue
add docstrings and fixes for ruff #336
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug documentation
Projects
FastKML
Status: Done
Hacktoberfest 2023
Status: Done
Milestone
Version 1.0
Development

Successfully merging a pull request may close this issue.

add docstrings and fixes for ruff cleder/fastkml
1 participant
@cleder