Skip to content

Fix Sphinx currentmodule directive for location choice documentation#1034

Merged
jpn-- merged 2 commits intomainfrom
copilot/fix-missing-doc-content
Feb 12, 2026
Merged

Fix Sphinx currentmodule directive for location choice documentation#1034
jpn-- merged 2 commits intomainfrom
copilot/fix-missing-doc-content

Conversation

Copy link
Contributor

Copilot AI commented Feb 12, 2026

The Implementation sections for work_location_choice and school_location_choice were not rendering because the currentmodule directive pointed to non-existent submodules.

Changes

  • work_location_choice.md: Corrected currentmodule from activitysim.abm.models.location_choice.workplace_location to activitysim.abm.models.location_choice
  • school_location_choice.md: Corrected currentmodule from activitysim.abm.models.location_choice.school_location to activitysim.abm.models.location_choice

The functions workplace_location and school_location are functions within the location_choice module, not submodules themselves. The fix aligns these docs with the pattern used throughout other component documentation (e.g., auto_ownership, mandatory_tour_frequency).

Original prompt

This section details on the original issue you should resolve

<issue_title>missing doc content</issue_title>
<issue_description>Describe the bug
The "implementation" section is not rendering any content.

To Reproduce
https://activitysim.github.io/activitysim/develop/dev-guide/components/work_location_choice.html#implementation

Expected behavior
Similar to other components, the API of this model should appear there.

As reported by @guyrousseau via email</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…ation_choice.md

Co-authored-by: jpn-- <1036626+jpn--@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix missing content in implementation section Fix Sphinx currentmodule directive for location choice documentation Feb 12, 2026
Copilot AI requested a review from jpn-- February 12, 2026 21:30
@jpn-- jpn-- marked this pull request as ready for review February 12, 2026 22:30
@jpn-- jpn-- merged commit 83613b2 into main Feb 12, 2026
2 checks passed
dhensle added a commit to RSGInc/activitysim that referenced this pull request Mar 4, 2026
commit c031c8b
Author: David Hensle <hensle93@gmail.com>
Date:   Fri Feb 13 15:48:35 2026 -0800

    adding ignore list to skim load for unused skims

commit 83613b2
Author: Copilot <198982749+Copilot@users.noreply.github.com>
Date:   Thu Feb 12 16:30:58 2026 -0600

    Fix Sphinx currentmodule directive for location choice documentation (ActivitySim#1034)

    * Initial plan

    * Fix currentmodule directive in work_location_choice.md and school_location_choice.md

    Co-authored-by: jpn-- <1036626+jpn--@users.noreply.github.com>

    ---------

    Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
    Co-authored-by: jpn-- <1036626+jpn--@users.noreply.github.com>

commit aa58cc4
Author: David Hensle <51132108+dhensle@users.noreply.github.com>
Date:   Fri Jan 16 03:31:07 2026 +1100

    Fix for zones reopening in simulation-based constraint mechanism for work/school location choice (ActivitySim#1028)

    * addresses issue with zones reopening after being closed in shadow_pricing

    * addresses issue with zones reopening after being closed in shadow_pricing

    * adding shadow price regression values

    * updating change log

    ---------

    Co-authored-by: juangacosta <juan.acosta@rsginc.com>

commit 6266ce4
Author: David Hensle <51132108+dhensle@users.noreply.github.com>
Date:   Thu Jan 8 10:26:48 2026 -0800

    Index names consistently set to "alt" for alternatives files (ActivitySim#1018)

    * "alt" now used as index in all alternatives modules

    * formatting

    * minor commenting

    * using stable sorting for unit test

    * adding to change log

    * updating school escort bundle Alt to alt

    * typo

    * Revert "updating school escort bundle Alt to alt"

    This reverts commit 625f685.

    * regenerate pipeline

    ---------

    Co-authored-by: juangacosta <juan.acosta@rsginc.com>
    Co-authored-by: Jeffrey Newman <jeff@driftless.xyz>

commit 0811191
Author: Jeffrey Newman <jeff@driftless.xyz>
Date:   Thu Jan 8 11:11:43 2026 -0600

    Repair CDAP estimation (ActivitySim#1026)

    * fix error in CDAP estimation model construction

    * update tests for CDAP

    * fix the other test file

    * add to changes.md

    * note on possible fixes
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.

missing doc content

2 participants