Skip to content

Commit 2b40c96

Browse files
committed
update docs
1 parent ea3f921 commit 2b40c96

7 files changed

Lines changed: 7 additions & 140 deletions

File tree

docs/developer/source-map.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ change crosses ownership boundaries.
4444
| Wrapper-planning errors and support claims | `x2py/semantics/policy_completion.py`, `x2py/wrapper_codegen/planner.py` | `docs/user/reference/diagnostic-codes.md`, `docs/user/language-support/feature-matrix.md` | `tests/semantics/policy/`, `tests/wrapper_codegen/` |
4545
| Source-driven Fortran wrapper orchestration | `x2py/pipeline/build.py` | `docs/user/reference/fortran-wrapper.md`, `docs/user/guide/building-shared-library.md` | `tests/wrapper/fortran/build_from_source/test_build_modes.py`, `tests/wrapper/fortran/multiple_files/test_multi_source_builds.py` |
4646
| Semantic `.pyi` wrapper orchestration from native artifacts | `x2py/pipeline/build.py`, `x2py/pipeline/pyi.py`, `x2py/semantics/pyi2ir.py` | `docs/user/reference/fortran-wrapper.md`, `docs/user/reference/semantic-pyi-format.md` | `tests/wrapper/fortran/build_from_pyi/test_pyi_wrapper_builds.py`, `tests/wrapper/fortran/build_from_pyi/test_contract_package_runtime.py` |
47-
| Ownership, lifetime, output projection, and unsupported wrapper policy | `x2py/semantics/policy_completion.py`, `x2py/semantics/ownership.py`, `x2py/wrapper_codegen/planner.py` | `docs/user/reference/fortran-wrapper.md`, `docs/user/reference/pyi-contracts/ownership-and-lifetimes.md` | `tests/semantics/policy/`, `tests/wrapper_codegen/`, `tests/wrapper/fortran/` |
47+
| Ownership, lifetime, output projection, and unsupported wrapper policy | `x2py/semantics/policy_completion.py`, `x2py/semantics/ownership.py`, `x2py/wrapper_codegen/planner.py` | `docs/user/guide/memory-management.md`, `docs/user/reference/semantic-pyi-format.md`, `docs/user/reference/fortran-wrapper.md` | `tests/semantics/policy/`, `tests/wrapper_codegen/`, `tests/wrapper/fortran/` |
4848
| Immediate callback policy, typed adapters, and trampolines | `x2py/semantics/wrapper_policy.py`, `x2py/semantics/policy_completion.py`, `x2py/wrapper_codegen/plan.py`, `x2py/wrapper_codegen/planner.py`, `x2py/wrapper_codegen/c/binding.py`, `x2py/wrapper_codegen/fortran/bridge.py` | `docs/user/guide/callbacks.md`, `docs/user/reference/semantic-pyi-format.md` | `tests/wrapper_codegen/test_phase10_callbacks.py`, `tests/wrapper/fortran/callbacks/` |
4949
| Native compilation, binding support, and shared-library linking | `x2py/pipeline/build.py`, `x2py/compiling/compilers.py`, `x2py/compiling/native_support.py` | `docs/user/reference/fortran-wrapper.md`, `docs/developer/build-system.md` | `tests/wrapper/fortran/build_from_source/test_runtime_abi.py`, `tests/wrapper/fortran/build_from_source/test_build_modes.py` |
5050
| Public Python exports | `x2py/__init__.py` | `README.md`, `docs/user/reference/python-api.md` | `tests/parsing/fortran/test_public_entrypoints.py` |

docs/maintainer/roadmap/documentation-content-checklist.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -275,8 +275,8 @@ primary placeholder queue.
275275
- [x] `docs/user/reference/semantic-pyi-format.md`: maintained semantic `.pyi`
276276
contract.
277277
- [x] `docs/user/reference/pyi-contracts/`: maintained editable `.pyi`
278-
contract reference, organized by exports, callable surfaces, call
279-
projection, and ownership.
278+
contract reference, organized by exports, callable surfaces, and argument
279+
and result projection.
280280
- [x] `docs/user/reference/fortran-wrapper.md`: maintained Fortran wrapper
281281
contract reference.
282282
- [x] `docs/user/reference/cli-commands.md`: maintained CLI reference.

docs/user/reference/pyi-contracts/calls-and-results.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: .pyi Calls and Results
33
audience: users, advanced users
44
prerequisites: editing .pyi contracts overview
5-
related: index.md, functions-and-classes.md, ownership-and-lifetimes.md, ../semantic-pyi-format.md, ../../guide/arrays.md, ../../guide/error-handling.md
5+
related: index.md, functions-and-classes.md, ../semantic-pyi-format.md, ../../guide/arrays.md, ../../guide/error-handling.md
66
status: maintained
77
publication: reviewed
88
---
@@ -156,6 +156,5 @@ covered in the [Callbacks](../../guide/callbacks.md) guide.
156156

157157
## Next
158158

159-
Most users can stop here. Read
160-
[Ownership and Lifetimes](ownership-and-lifetimes.md) only when editing
161-
explicit ownership annotations.
159+
Most users can stop here. Return to
160+
[Editing `.pyi` Contracts](index.md) to choose another edit.

docs/user/reference/pyi-contracts/index.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Editing .pyi Contracts
33
audience: users, advanced users
44
prerequisites: generated .pyi contract, wrapper build workflow
5-
related: exports-and-modules.md, functions-and-classes.md, calls-and-results.md, ownership-and-lifetimes.md, ../semantic-pyi-format.md
5+
related: exports-and-modules.md, functions-and-classes.md, calls-and-results.md, ../semantic-pyi-format.md
66
status: maintained
77
publication: reviewed
88
---
@@ -74,14 +74,6 @@ to compare and undo.
7474
- [How do I keep Python's Global Interpreter Lock (GIL) during a call, or return to the normal releasing behavior?](calls-and-results.md#keep-the-gil-when-required)
7575
- [How do I describe a callback signature in the contract?](../../guide/callbacks.md#choosing-the-prototype-spelling)
7676

77-
### Storage and Lifetimes
78-
79-
- [How do I understand or edit a complete ownership rule?](ownership-and-lifetimes.md#the-complete-ownership-rule)
80-
- [How do I choose a value, copy, view, existing object, or new handle?](ownership-and-lifetimes.md#transfer-values)
81-
- [How do I decide who releases persistent storage?](ownership-and-lifetimes.md#destruction-values)
82-
- [How do I understand allocatable or pointer handle ownership?](ownership-and-lifetimes.md#common-handle-cases)
83-
- [Why is an ownership combination rejected?](ownership-and-lifetimes.md#combinations-that-are-rejected)
84-
8577
Most edits change the Python surface: names, visibility, grouping, or how
8678
native arguments appear as Python parameters and results.
8779

docs/user/reference/pyi-contracts/ownership-and-lifetimes.md

Lines changed: 0 additions & 122 deletions
This file was deleted.

mkdocs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,6 @@ nav:
9292
- Exports and Modules: user/reference/pyi-contracts/exports-and-modules.md
9393
- Functions and Classes: user/reference/pyi-contracts/functions-and-classes.md
9494
- Calls and Results: user/reference/pyi-contracts/calls-and-results.md
95-
- Ownership and Lifetimes: user/reference/pyi-contracts/ownership-and-lifetimes.md
9695
- Diagnostic Codes: user/reference/diagnostic-codes.md
9796
- Generated Functions: user/reference/generated-functions.md
9897
- Generated Modules: user/reference/generated-modules.md

tests/docs/test_structure.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,6 @@
125125
"user/reference/pyi-contracts/exports-and-modules.md",
126126
"user/reference/pyi-contracts/functions-and-classes.md",
127127
"user/reference/pyi-contracts/calls-and-results.md",
128-
"user/reference/pyi-contracts/ownership-and-lifetimes.md",
129128
"user/reference/diagnostic-codes.md",
130129
]
131130
REQUIRED_ROADMAP_PAGES = [

0 commit comments

Comments
 (0)