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

Docstrings for Source classes and other things #90

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

handrews
Copy link
Contributor

Add docstrings for Source, LocalSource, and RemoteSource.

Also note the automatic use of the default catalog in the docstring for create_catalog(), so that it is clear that there is no need to do anything with its return value when no name is provided.

First half of the replacement for #79, which I know was not slated for 0.10.1

@codecov-commenter
Copy link

codecov-commenter commented Apr 10, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (e6f71d0) 92.73% compared to head (ab3e1ab) 92.73%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #90   +/-   ##
=======================================
  Coverage   92.73%   92.73%           
=======================================
  Files          23       23           
  Lines        2052     2052           
  Branches      435      435           
=======================================
  Hits         1903     1903           
  Misses         97       97           
  Partials       52       52           
Files Changed Coverage Δ
jschon/__init__.py 90.00% <ø> (ø)
jschon/catalog/__init__.py 98.17% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@handrews
Copy link
Contributor Author

More mysterious test time-outs which I'm pretty sure have nothing to do with this docstring change.

BTW I am happy to remove the warning about http(s) URIs and not overloading servers in the RemoteSource if you prefer- I've just noticed that it's very common for people to think that HTTP URIs means that you should fetch remotely every time, when it's actually discouraged (not to mention a giant security hole depending on where you're fetching things from).

Add docstrings for Source, LocalSource, and RemoteSource.

Also note the automatic use of the default catalog in the
docstring for create_catalog(), so that it is clear that
there is no need to do anything with its return value
when no name is provided.
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