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

Docstring testing + return sorted table names #20

Merged
merged 5 commits into from
Sep 3, 2024
Merged

Conversation

prakaa
Copy link
Member

@prakaa prakaa commented Sep 3, 2024

  • Ensures that doctests are tested by changing pyproject.toml pytest config for test dirs
  • Update docstring example to reflect new tables, new functionality, etc.
  • get_table_names now returns a sorted list of tables

Closes #19, closes #17

@prakaa prakaa requested a review from nick-gorman September 3, 2024 05:52
Copy link

codecov bot commented Sep 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines Coverage Δ
src/isp_workbook_parser/config_model.py 100.00% <ø> (ø)
src/isp_workbook_parser/parser.py 84.66% <100.00%> (+4.00%) ⬆️
src/isp_workbook_parser/read_table.py 100.00% <ø> (ø)

Copy link
Member

@nick-gorman nick-gorman left a comment

Choose a reason for hiding this comment

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

Docstrings tests are running, output looks good, and returning table names sorted is definitely the way to go.

@nick-gorman nick-gorman merged commit f8b6495 into main Sep 3, 2024
15 checks passed
@nick-gorman nick-gorman deleted the docstring_testing branch September 3, 2024 23:26
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.

Docstrings not being tested get_table_names should be sorted by default?
2 participants