Skip to content

Mismatch between params and docstring in function br.gi.ags3.ags3_to_brgi_db_mapping() #57

@konnerhorton

Description

@konnerhorton

Function: ags3_to_brgi_db_mapping() in br.gi.ags3 (line 128)

Issue: Function includes source as the first parameter, the docstring has ags3_db. The function generates the db from source in the first line but the docstring indicates this should be done outside the function.

What is the expected use case? Should we generate the ags db outside of this function with ags_to_dfs(source), then pass the result to ags3_to_brgi_db_mapping()? Or leave ags3_to_brgi_db_mapping() as is and update the docstring?

I think we can maintain a more flexibility by going with the former (being consistent with the docstring). Though some other changes would need to follow (ags_to_brgi_db_mapping())

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions