Skip to content

False negative inside docstring #102

@hugo-viana

Description

@hugo-viana

Hi,

I have a problem using this plugin in a docstring lint validation.

My docstring is:

def dummy_df():
    """Return dummy dataframe.

    Example:

        >>> from pyspark.sql import SparkSession
        >>> spark = SparkSession.builder.getOrCreate()
        >>> df = spark.createDataFrame(
        ...     [
        ...         ("2021-08-31", "2021-05-31 00:00:00", "A", "A", "A"),
        ...         ("2021-05-31", "2021-01-31 00:00:00", "B", "B", "B"),
        ...     ],
        ...     [
        ...         "effective_end_date", "effective_start_date",
        ...         "entity_id", "country_id", "iuc",
        ...     ],
        ... )

And it returns a JS101 Multi-line container not broken after opening character twice in the list's closing brackets. In my opinion this it shouldn't be happening.

Also, have tried several different combinations but the result is still the same.

Is this a bug? or is there any explanation or workarround to aplly in this cases?

Best regards,

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