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.

Sign up for GitHub

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

Jump to bottom

pyln_client: (re-)adds method description to usage via docstring #7680

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

pyln_client: (re-)adds method description to usage via docstring #7680

wants to merge 4 commits into from

Commits on Sep 20, 2024

  1. pyln-client: adds description to methods via docstring 

    The old `long_description` was removed and deprecated a while ago
without adding a proper replacement for plugin developers.
The getmanifest JSON that was to be used for that only knows `name` and `usage`.

This PR adds an optional `description` parameter that will be filled
with the methods docstring `__doc__` (if set).

Example:

    @p.method("example")
    def some_method(...)
        """some description"""
        ...

Changelog-Add: optional description paramter to Plugin.Method
    @m-schmoock
    m-schmoock committed Sep 20, 2024
    Configuration menu
    Copy the full SHA
    c7d2a49 View commit details
    Browse the repository at this point in the history

  2. pyln-client: refactors usage string generation to reduce code duplica… 

    …tion
    @m-schmoock
    m-schmoock committed Sep 20, 2024
    Configuration menu
    Copy the full SHA
    e8ba365 View commit details
    Browse the repository at this point in the history

  3. pyln-client: adds testcase for usage in manifest and print_usage

    @m-schmoock
    m-schmoock committed Sep 20, 2024
    Configuration menu
    Copy the full SHA
    4dbdb14 View commit details
    Browse the repository at this point in the history

  4. pytest: fix a test that broke because of docstring usage

    @m-schmoock
    m-schmoock committed Sep 20, 2024
    Configuration menu
    Copy the full SHA
    d7c9f08 View commit details
    Browse the repository at this point in the history