Skip to content
This repository was archived by the owner on Sep 8, 2025. It is now read-only.

API docs + some fine tuning for Plugin API#1424

Merged
cburgdorf merged 4 commits intoethereum:masterfrom
cburgdorf:christoph/docs/plugins
Oct 25, 2018
Merged

API docs + some fine tuning for Plugin API#1424
cburgdorf merged 4 commits intoethereum:masterfrom
cburgdorf:christoph/docs/plugins

Conversation

@cburgdorf
Copy link
Copy Markdown
Contributor

@cburgdorf cburgdorf commented Oct 22, 2018

What was wrong?

Plugins didn't have proper API docs yet. There were also some easy to fix glitches that this PR addresses. Notice that this is just a first step towards a full detailed plugin guide which is coming in a separate PR (#1429 )

How was it fixed?

  • created API docs
  • created TrinityBootInfo type to reduce complexity of several method signatures
  • Use pass instead of raise for abstract methods
  • Fix that ugly thing were we return None as a context

Cute Animal Picture

put a cute animal picture link inside the parentheses

@cburgdorf cburgdorf force-pushed the christoph/docs/plugins branch 2 times, most recently from b6ebfda to a4fb07c Compare October 23, 2018 14:31
chain:
--data-dir DATA_DIR The directory where chain data is stored
--nodekey NODEKEY Hexadecimal encoded private key to use for the nodekey
--nodekey-path NODEKEY_PATH
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

side note: we should be able to merge the functionality of this argument in with the --nodekey argument and just do detection on whether the arg is referencing a file or that it's just a string nodekey.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Created an issue #1428

Copy link
Copy Markdown
Member

@pipermerriam pipermerriam left a comment

Choose a reason for hiding this comment

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

random musings.

Extensibility
=============

.. note::
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe .. warning::?

Comment thread trinity/extensibility/plugin.py Outdated
Describe the name of the plugin
Describe the name of the plugin.
"""
raise NotImplementedError(
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

you could replace this NotImplementedError with a pass (our current convention).

@cburgdorf cburgdorf force-pushed the christoph/docs/plugins branch 3 times, most recently from b28d04e to 9a8b639 Compare October 24, 2018 18:27
@cburgdorf cburgdorf force-pushed the christoph/docs/plugins branch from 9a8b639 to 9389ab0 Compare October 25, 2018 09:05
@cburgdorf cburgdorf changed the title Christoph/docs/plugins API docs + some fine tuning for Plugin API Oct 25, 2018
@cburgdorf
Copy link
Copy Markdown
Contributor Author

@pipermerriam I decided to spin out the guide into a separate PR (#1429) as writing the guide will still take a bit more time and I think we can get this in independently from the guide.

Copy link
Copy Markdown
Member

@pipermerriam pipermerriam left a comment

Choose a reason for hiding this comment

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

👍 but a bit of a rubber stamp. Didn't 👀 all of the docstrings carefully.

@cburgdorf cburgdorf merged commit be73676 into ethereum:master Oct 25, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants