Skip to content

Conversation

@John-P
Copy link
Contributor

@John-P John-P commented Mar 11, 2023

Changes

  • Change docstring examples to use concrete classes.
  • Add custom warning when attempting to instantiate the abstract base class.
  • Replace occurrences of store.add with store.append in examples.
  • Fix bug with DictionaryStore.bquery and geometry=None, i.e. only a where predicate given.

Documentation

The live build is at https://tia-toolbox.readthedocs.io/en/docs-ann-store-eg/
Annotation storage module: https://tia-toolbox.readthedocs.io/en/docs-ann-store-eg/_autosummary/tiatoolbox.annotation.storage.html#module-tiatoolbox.annotation.storage

@John-P John-P added the documentation Improvements or additions to documentation label Mar 11, 2023
@John-P John-P self-assigned this Mar 11, 2023
@John-P John-P linked an issue Mar 11, 2023 that may be closed by this pull request
4 tasks
@John-P John-P requested a review from shaneahmed March 11, 2023 10:49
@John-P John-P changed the title DOC: Improve Annotation Store Documentation and Usability 📝 DOC: Improve Annotation Store Documentation and Usability Mar 11, 2023
@John-P John-P changed the title 📝 DOC: Improve Annotation Store Documentation and Usability 📝 DOC: Improve Annotation Store Documentation + Bug Fixes Mar 11, 2023
@John-P John-P changed the title 📝 DOC: Improve Annotation Store Documentation + Bug Fixes 📝 DOC: Improve Annotation Store Documentation + Fix Bug Mar 11, 2023
@codecov
Copy link

codecov bot commented Mar 11, 2023

Codecov Report

Merging #565 (a619427) into develop (adf42f5) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head a619427 differs from pull request most recent head 7336038. Consider uploading reports for the commit 7336038 to get more accurate results

@@           Coverage Diff            @@
##           develop     #565   +/-   ##
========================================
  Coverage    99.51%   99.51%           
========================================
  Files           62       62           
  Lines         6590     6594    +4     
  Branches      1077     1078    +1     
========================================
+ Hits          6558     6562    +4     
  Misses          20       20           
  Partials        12       12           
Impacted Files Coverage Δ
tiatoolbox/annotation/storage.py 99.61% <100.00%> (+<0.01%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@shaneahmed shaneahmed mentioned this pull request Mar 13, 2023
4 tasks
Copy link
Member

@shaneahmed shaneahmed left a comment

Choose a reason for hiding this comment

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

Thanks @John-P
All good. Just a minor suggestion which you can commit online.

Co-authored-by: Shan E Ahmed Raza <13048456+shaneahmed@users.noreply.github.com>
@shaneahmed shaneahmed merged commit 8ce0ebf into develop Mar 16, 2023
@shaneahmed shaneahmed deleted the docs-ann-store-eg branch March 16, 2023 11:08
@shaneahmed shaneahmed added this to the Release v1.4.0 milestone Apr 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation inconistency

3 participants