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

Updated docs/docstrings #100

Merged
merged 5 commits into from
Apr 22, 2024
Merged

Updated docs/docstrings #100

merged 5 commits into from
Apr 22, 2024

Conversation

charlottekostelic
Copy link
Contributor

@charlottekostelic charlottekostelic commented Apr 15, 2024

Changed:

  • reformatted docstrings across package to improve readability on github pages
  • changed format of docstrings used by mkdocstrings so that longer descriptions render better online
  • updated idna to 3.7
  • fixed typos
  • updated release checklist and moved it to contributing.md

Added:

  • exceptions raised in docstrings
  • examples of managing shared print commitments to local.md
  • Error handling in bib_get_current_oclc_number (ValueError is raised if more than 10 OCLC Numbers are passed as an arg)

Copy link
Member

@klinga klinga left a comment

Choose a reason for hiding this comment

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

Good changes. I like your take on the docstring formatting and richer information.
Solid!
@charlottekostelic Would you be able to bring the coverage to 100%?

@charlottekostelic
Copy link
Contributor Author

Added another test so coverage should be 100% now.

@charlottekostelic charlottekostelic merged commit 1ee3133 into releases/v1.0.1 Apr 22, 2024
9 checks passed
@charlottekostelic charlottekostelic deleted the update-docs branch April 22, 2024 21:29
charlottekostelic added a commit that referenced this pull request May 6, 2024
* updated black to 24.3.0 (#96)

* Fixed inconsistency in timeout types/default values (#98)

* fixed inconsistency in timeout default values

* type fixes in WorldcatAccessToken

* test refactor, fixed typos and timeout assignment

* fixed timeout in Query, added file for live tests

* added int type for oclcNumbers arg (#97)

* Updated docs/docstrings (#100)

* reformatted doc strings, updated documentation

* updated dependencies, changelog

* clean up of MetadataSession docstrings

* moved release checklist to contributing page

* added bib_get_current_oclc_number test

* Added tutorials to docs (#102)

* Added tutorial draft and updated mkdocs.yml

* Updated Full MARC reocrds use case

* Added holdings use case to tutorial

* tutorial edits

* updated tutorials

* Updated tutorials

* Simplified layout and made copy edits

* Updated changelog

* Updated OCLC Number prefix handling (#104)

* changed oclc prefix handling, refactored tests

* updated prefix handling section in docs

* updated changelog and fixed type issue in utils.py

* fixed oclc prefixes
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.

2 participants