FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Add an API reference page for the `virtual_rows` module · Issue #54 · pythonnative/pythonnative · GitHub

Repository navigation

Add an API reference page for the virtual_rows module #54

Description

Problem

src/pythonnative/virtual_rows.py is a public module with a full module docstring and Google-style class docs for RowSubtree and RowHostPool (it declares __all__ = ["RowSubtree", "RowHostPool"]), and it's covered by tests/test_native_lists.py. It's the piece that mounts a nested reconciler per row for natively virtualized lists (FlatList / SectionList on RecyclerView and UITableView).

There's no API reference page for it. mkdocs.yml lists a page for every other core module under API Reference (lines 106-135: reconciler, mutations, events, platform_metrics, native_views, and so on), but virtual_rows is missing, and nothing under docs/ mentions the module.

This is separate from #41, which covers the preview module.

Suggested fix

  • Add docs/api/virtual_rows.md following the pattern of docs/api/mutations.md: a one-paragraph intro, then

    ::: pythonnative.virtual_rows
        options:
          show_root_heading: false
          show_root_toc_entry: false
          members_order: source
          filters: ["!^_"]

    and a short "Next steps" list linking to reconciler.md, native_views.md, and ../guides/lists.md.

  • Add - Virtual rows: api/virtual_rows.md to the API Reference nav in mkdocs.yml, near Reconciler / Native views.

  • Optionally add a sentence with a link to the new page in docs/guides/lists.md where it describes per-row rendering.

Follow the documentation style guide for the prose.

Verification

  • uv run --group docs mkdocs build --strict passes (strict mode fails on broken cross-references).
  • uv run --group docs mkdocs serve shows the page with both classes rendered and the intra-doc links resolving.

Suggested commit message

docs(mkdocs): add virtual_rows API reference page

Activity

  1. Mdwali79986 commented on Sep 2, 2026

    Hi, I'd like to work on this issue. Could you please assign it to me?

  2. owenthcarey commented on Sep 2, 2026

    ContributorAuthor

    Awesome! Assigned to you.

  3. owenthcarey commented on Sep 9, 2026

    ContributorAuthor

    @Mdwali79986, the runtime overhaul in #80 removed src/pythonnative/virtual_rows.py, including RowSubtree and RowHostPool. Lists now participate in the shared logical application tree instead of the per-row reconciler model described in this issue. The current design is covered in the architecture guide and lists guide.

    Closing as not planned because the module this issue asked you to document no longer exists. Please don't add the old mkdocstrings page or recreate those APIs. Sorry the issue wasn't updated alongside the overhaul, and thank you for volunteering. A documentation task for the new internals would need its own scope.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions


    Back | FazBrowse Home | New Git URL