Skip to content

Floating point default values not being rendered. #18

@mashrurmorshed

Description

@mashrurmorshed

Describe the bug:
Decimal points are missed in default float values.

For example, if I have a function def foo(x = 0.01):, the docs will show x = 01. The markdown generator is unable to handle floating point default values.

Expected behaviour:

I expect my default floating point values to show up how I specified them in the code.

Steps to reproduce the issue:

For example, for the following function:

def foo(x : float = 0.01, y : int = 2) -> float:
    """Some function.

    Args:
        x (float, optional): A float number. Defaults to 0.01.
        y (int, optional): An integer. Defaults to 2.

    Returns:
        float: Their product.
    """     

    return x * y

Lazydoc renders it as:

image

Note the x=01, missing the ".".

Technical details:

  • Host Machine OS (Windows/Linux/Mac): Linux
  • Browser (Chrome/Firefox/Safari): Firefox

Possible Fix:

Most likely there isn't any floating point support, or something's missing somewhere. I believe this should be an easy fix.

Additional context:

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions