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

docs: Document inherited PluginBase attributes and methods #1243

Merged
merged 2 commits into from
Dec 6, 2022

Conversation

edgarrmondragon
Copy link
Collaborator

@edgarrmondragon edgarrmondragon commented Dec 5, 2022

Some attributes and methods, such as Tap.print_version, weren't documented because we exclude PluginBase from the docs (probably with good reason, since developers should seldom need to subclass it directly).

Now they're documented: https://meltano-sdk--1243.org.readthedocs.build/en/1243/classes/singer_sdk.Tap.html#singer_sdk.Tap.print_version


📚 Documentation preview 📚: https://meltano-sdk--1243.org.readthedocs.build/en/1243/

@edgarrmondragon edgarrmondragon marked this pull request as ready for review December 5, 2022 22:40
@codecov
Copy link

codecov bot commented Dec 6, 2022

Codecov Report

❗ No coverage uploaded for pull request base (main@c94ae17). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1243   +/-   ##
=======================================
  Coverage        ?   83.67%           
=======================================
  Files           ?       42           
  Lines           ?     3909           
  Branches        ?      666           
=======================================
  Hits            ?     3271           
  Misses          ?      474           
  Partials        ?      164           
Impacted Files Coverage Δ
singer_sdk/plugin_base.py 73.98% <ø> (ø)

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

@edgarrmondragon edgarrmondragon merged commit faed940 into main Dec 6, 2022
@edgarrmondragon edgarrmondragon deleted the docs/document-inherited-plugin-attrs branch December 6, 2022 23:08
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.

None yet

1 participant