Skip to content

Document park-and-ride lot choice and capacity - #1112

Open
jpn-- wants to merge 1 commit into
ActivitySim:mainfrom
driftlesslabs:docs/park-and-ride-1001
Open

Document park-and-ride lot choice and capacity#1112
jpn-- wants to merge 1 commit into
ActivitySim:mainfrom
driftlesslabs:docs/park-and-ride-1001

Conversation

@jpn--

@jpn-- jpn-- commented Sep 9, 2026

Copy link
Copy Markdown
Member

PR #1001 added explicit park-and-ride lot choice and capacity feedback without an accompanying documentation page. This documents what the feature implements and how agencies can configure it, addressing the request for usage documentation.

Adds a Markdown component page following the existing documentation pattern, with configuration fragments, land-use inputs, workflow placement, skim wrappers, eligibility and availability requirements, capacity iteration and diagnostics, logsum support, and at-work subtour behavior. Links it from the component index and tour mode choice page, and explains per-entry matrix endpoints for drive and transit legs.

The guide distinguishes illustrative configuration from a runnable agency example and documents capacity limitations, including tour-based occupancy, specification-controlled full-lot availability, and the iteration limit.

Validation:

  • Repository pre-commit checks passed.
  • Sphinx HTML build succeeded; the build reports documentation warnings, including repeated section labels across component pages.
  • YAML fragments validated against the actual model settings classes.
  • Rendered pages checked for system messages and internal link targets.

Documentation only; no simulation behavior changed.

Note: This PR authored by GPT-6-Astra-Medium.

@jpn--
jpn-- requested review from dhensle and a balanced review from Copilot September 9, 2026 01:51

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The documentation accurately reflects the implemented configuration, iteration, skim, and matrix behavior.

Pull request overview

Documents explicit park-and-ride lot choice, capacity feedback, and configuration.

Changes:

  • Adds a comprehensive component guide.
  • Documents park-and-ride matrix endpoints and mode-choice integration.
  • Adds navigation links.
File summaries
File Description
docs/dev-guide/components/park_and_ride_lot_choice.md Adds the component guide.
docs/dev-guide/components/write_trip_matrices.md Explains drive/transit leg matrices.
docs/dev-guide/components/tour_mode_choice.md Documents park-and-ride integration.
docs/dev-guide/components/index.rst Adds the component to the index.
Review details
  • Files reviewed: 4/4 changed files
  • Comments generated: 0
  • Review effort level: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

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.

2 participants