Repository navigation
Harmonize the documentation layout and the API reference with pulserver and pypulseqpp - #38
Merged
Merged
Conversation
… exemplar) Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011YDG7p9iof3Ah6DpETkxik
Simulator classes carry their protocol and tissue properties; every parameter states its default and unit; returns state their shapes. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011YDG7p9iof3Ah6DpETkxik
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011YDG7p9iof3Ah6DpETkxik
…ures Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011YDG7p9iof3Ah6DpETkxik
User and developer guides as directories, internals under the developer guide, Examples landing pages with Course and Applications tables, tables on the Explanations and Miscellaneous landing pages. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011YDG7p9iof3Ah6DpETkxik
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011YDG7p9iof3Ah6DpETkxik
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011YDG7p9iof3Ah6DpETkxik
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011YDG7p9iof3Ah6DpETkxik
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Before: the user and developer guides were single pages. The explanations and the API index were definition lists. Examples had no Course or Applications landing pages. Every API object page sat in the sidebar with its full signature, and many Parameters entries read
type, optional. The version banner read "unknown version".After: the sidebar reads User guide, Developer guide, Explanations, Examples (Course, Applications), API reference, Miscellaneous. Each landing page carries a concept-named table. Object pages are reachable from
{obj}tables collected bydocs/api_objects.py, so they stay out of the sidebar, and each is headedName(). Every Parameters entry statestype, default=value, andtests/test_docstring_defaults.pyholds each stated default to the signature. The banner reads the version.How: this follows the harmonized-layout instructions for blochsim, items 1 to 10.
_compact_signatureruns onautodoc-process-signature. The developer guide is split into Installation, Workflow, Style, Documentation, Terminology and Internals. The code of conduct moves to Workflow. Simulator tissue properties are documented in a "Tissue properties" section.Waiting on Matteo's review of the rendered pages before merging.
🤖 Generated with Claude Code
https://claude.ai/code/session_011YDG7p9iof3Ah6DpETkxik
Generated by Claude Code