Skip to content

Parameter description parsing captures less indented text of another section #29

Closed

Description

@Ark-kun

Expected behavior: Parameter description ends when there parser encounters less indented line.

Actual behavior: The parameter description capturing does not seem to stop when less indented line is encountered and captures it as well.

def foo():
    '''Converts Keras HDF5 model to Tensorflow SavedModel format.

    Args:
        model_path: Keras model in HDF5 format.
        converted_model_path: Keras model in Tensorflow SavedModel format.

    Annotations:
        author: Alexey Volkov <alexey.volkov@ark-kun.com>
    '''

The description for converted_model_path becomes:

Keras model in Tensorflow SavedModel format.
Annotations:

P.S. It would be really great if it was possible to parse additional sections that are not currently recognized by the docstring_parser.

Activity

  1. rr- commented on Sep 21, 2020

    @rr-
    Owner

    Unfortunately I don't have capacity to work on open source atm, so a pull request is encouraged.

    I agree about unknown sections, although we should try and attempt to maintain backwards compatibility.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions