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

Adding missing documentation parameters #136

Merged
merged 2 commits into from
Nov 14, 2023

Conversation

joabda
Copy link
Contributor

@joabda joabda commented Oct 5, 2023

Issue Description:
In the pubhub documentation for create_dhcp_pool the lease parameters are missing.

Changes:
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
    """

Unit Testing:
None required, changes only affect comment part.

@joabda joabda requested a review from a team as a code owner October 5, 2023 19:59
@joabda
Copy link
Contributor Author

joabda commented Oct 5, 2023

@GerriorL what about this failing run?

@GerriorL
Copy link
Contributor

GerriorL commented Oct 5, 2023

@GerriorL what about this failing run?

We don't support 3.7 anymore

@joabda
Copy link
Contributor Author

joabda commented Nov 11, 2023

@GerriorL Anything required on my side to merge this?

@omehrabi
Copy link
Contributor

could you merge master and push again

@joabda
Copy link
Contributor Author

joabda commented Nov 13, 2023

@omehrabi Done

@joabda
Copy link
Contributor Author

joabda commented Nov 14, 2023

@GerriorL @omehrabi Anything required on my side to merge this?

@omehrabi omehrabi merged commit c4c857e into CiscoTestAutomation:master Nov 14, 2023
4 checks passed
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

Successfully merging this pull request may close these issues.

3 participants