Skip to main content

behave_auto_docstring

Adds a simple docstring to behave step, e.g.

from behave_auto_docstring import when

@when("A function is declared")
def function(context): ...

is equivalent to

from behave import when

@when("A function is declared")
def function(context):
    """
    Usage:

    ```gherkin
    When A function is declared
    ```
    """"

Usage with mkdocs

For mkdocstrings to parse the resulting docs, you need to add

plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            extensions:
              - behave_auto_docstring.griffe

to your mkdocs.yml file.

Metadata

Release files for behave-auto-docstring 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for behave-auto-docstring 0.1.3
File Size Uploaded Provenance
behave_auto_docstring-0.1.3.tar.gz 2.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for behave-auto-docstring 0.1.3
File Interpreter ABI Platform
behave_auto_docstring-0.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 6.7 kB

Release files / behave_auto_docstring-0.1.3.tar.gz

Download URL behave_auto_docstring-0.1.3.tar.gz
Size 2.7 kB
Tags Source
SHA-256 checksum
How to use checksums
e4245ffa9c3c8a0e0fd03103f6ee7dd674e18c489912cdb837403c1b68d8a834
BLAKE2b-256 checksum
How to use checksums
214aac4077ce6b11260481cbb5bdf0aa083c6467b3db1cce61571f78da1500e7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.8.22

Release files / behave_auto_docstring-0.1.3-py3-none-any.whl

Download URL behave_auto_docstring-0.1.3-py3-none-any.whl
Size 4.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1ddbf9fa471b4f0f5a88099a8509c681351837f1abaa28fa51538c605ab10a4a
BLAKE2b-256 checksum
How to use checksums
e5ec7943538b3301cba237b799aceb8477e26a4b394c2452993581a88593810b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.8.22

Security for behave-auto-docstring 0.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page