Skip to content

Add better docs#135

Draft
ankoure wants to merge 4 commits intomainfrom
add-better-docs
Draft

Add better docs#135
ankoure wants to merge 4 commits intomainfrom
add-better-docs

Conversation

@ankoure
Copy link
Contributor

@ankoure ankoure commented Feb 6, 2026

This PR works to add google style docstrings to functions, combined with mkdocs to both render this into a more accessible format and also to add more context for big picture gobble stuff.


@tracer.wrap()
def add_gtfs_headways(event_df: pd.DataFrame, all_trips: pd.DataFrame, all_stops: pd.DataFrame) -> pd.DataFrame:
"""
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: review this comment change. Make sure that the message of the original prose is not lost. Maybe, consider adding this as a mkdocs page under design philosophy or other gotchas?

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.

1 participant