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.

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

Missing API parameters in documentation #135

Closed
joabda opened this issue Sep 29, 2023 · 3 comments
Closed

Missing API parameters in documentation #135

joabda opened this issue Sep 29, 2023 · 3 comments
Assignees

Comments

@joabda
Copy link
Contributor

joabda commented Sep 29, 2023

def create_dhcp_pool(
device, pool_name, network, mask, router_id,lease_days,lease_hrs,lease_mins
):
""" Create DHCP pool
Args:
device ('obj'): device to use
pool_name ('str'): name of the pool to be created
network ('str'): IP of the network pool
mask ('str'): Subnet mask of the network pool
router_id ('str'): Default router ID
Returns:
None
Raises:
SubCommandFailure: Failed creating dhcp pool
"""

In the pubhub documentation for create_dhcp_pool the lease parameters are missing.

I proposed to replace the current function's documentation with the following:

def create_dhcp_pool(
    device, pool_name, network, mask, router_id,lease_days,lease_hrs,lease_mins
):
    """ Create DHCP pool
        Args:
            device ('obj'): device to use
            pool_name ('str'): name of the pool to be created
            network ('str'): IP of the network pool
            mask ('str'): Subnet mask of the network pool
            router_id ('str'): Default router ID
            lease_days ('str'): Number of days for the lease
            lease_hrs ('str'): Number of hours for the lease
            lease_mins ('str'): Number of minutes for the lease
        Returns:
            None
        Raises:
            SubCommandFailure: Failed creating dhcp pool
    """

I assume the pubhub documentation is generated from the python function documentation.

@sowmyadn010501
Copy link

Hello joabda,
I will be looking in to your issue. Kindly give me some time to analyze the issue.

@SohanTirpude
Copy link

@joabda raised the PR #136 for this issue.

@sowmyadn010501
Copy link

As your PR has been merged, the changes will reflect next new version. Hence closing this ticket
In the future after the changes has been reflected, if you still face the issue we can reopen this ticket.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants