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

0.2.1: docs for get and setter functions are incomplete #3

Closed
markjoshwel opened this issue Mar 9, 2024 · 4 comments
Closed

0.2.1: docs for get and setter functions are incomplete #3

markjoshwel opened this issue Mar 9, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@markjoshwel
Copy link
Owner

markjoshwel commented Mar 9, 2024

def get_toml_field(
    document: TOMLDocument,
    location: Union[str, Tuple[str, ...]],
    default: Any = None,
) -> Any:
    """
    safely retrieve a toml documents field by it's location. not recommended for general
    use due to a lack of type information, but useful when accessing fields
    programatically

    arguments:
        - location: `str | tuple[str, ...]`
        - default: `Any` = `None`

    returns the field if it exists, otherwise `default`
    """

arguments list is missing document

@markjoshwel markjoshwel added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 9, 2024
@markjoshwel markjoshwel self-assigned this Mar 9, 2024
@markjoshwel
Copy link
Owner Author

same for set_toml_field

@markjoshwel markjoshwel changed the title 2.0.1: get_toml_field docstring is missing an argument 2.0.1: get_toml_field and set_toml_field docstring is missing an argument Mar 9, 2024
@markjoshwel
Copy link
Owner Author

both apply also for the README.md

@markjoshwel
Copy link
Owner Author

hell, _get_model_field() too

@markjoshwel markjoshwel changed the title 2.0.1: get_toml_field and set_toml_field docstring is missing an argument 2.0.1: get and setter function documentation are incomplete Mar 9, 2024
@markjoshwel markjoshwel changed the title 2.0.1: get and setter function documentation are incomplete 2.0.1: docs for set and setter functions are incomplete Mar 9, 2024
@markjoshwel markjoshwel changed the title 2.0.1: docs for set and setter functions are incomplete 2.0.1: docs for get and setter functions are incomplete Mar 9, 2024
@markjoshwel markjoshwel changed the title 2.0.1: docs for get and setter functions are incomplete 0.2.1: docs for get and setter functions are incomplete Mar 9, 2024
@vlshields
Copy link
Contributor

Hi @markjoshwel !

I'm new here. I just submitted a PR for this issue. I only updated the get_toml_field function for now. But if I did it right I will update the others you mentioned (separate branch for each of course).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants