Skip to content

docs: render experimental API notices - #4315

Open
Soumoditya wants to merge 1 commit into
scikit-hep:mainfrom
Soumoditya:Soumoditya/docs-experimental-api-marker
Open

docs: render experimental API notices#4315
Soumoditya wants to merge 1 commit into
scikit-hep:mainfrom
Soumoditya:Soumoditya/docs-experimental-api-marker

Conversation

@Soumoditya

@Soumoditya Soumoditya commented Aug 22, 2026

Copy link
Copy Markdown

Summary

  • preserve the @experimental marker while AutoAPI parses source files
  • render a stability warning for marked functions, methods, and properties

Fixes #4300.

Validation

  • exercised the patched parser with bare and parenthesized decorators, plus marked properties and methods
  • rendered every affected template with marked and unmarked objects
  • passed pre-commit.ci - pr

AI assistance

This change was developed with substantial assistance from OpenAI Codex. I reviewed the AutoAPI parser contract, the repository's existing documentation configuration, and the resulting diff and focused validation output before submitting it.

@github-actions github-actions Bot added the type/docs PR title type: docs (set automatically) label Aug 22, 2026
@Soumoditya
Soumoditya marked this pull request as ready for review August 22, 2026 23:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/docs PR title type: docs (set automatically)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The experimental mark does not appear in the rendered API reference

1 participant