Repository navigation
Make the documentation match the code, and test the examples properly - #41
Merged
Merged
Conversation
Docs: - index.md: accurate variable types, platforms (prebuilt: Windows/Linux x86_64), architecture, supported features and a real limitations list; remove links to the non-existent api.md and Discussions - Quick-start and PID examples registered variables before creating the attributes / under different names, so inputs and parameters had no setter (PID would fail to build). Explain the create-then-register rule. - usage.md: Fmi3StepResult fields table, logging, units, array-size note - usageMX.md: what is required vs optional, value-reference numbering, update_discrete_states example now returns its result, result fields - README: real `pythonfmu3 build` options, missing imports in the MX example - install.md: build-from-source requirements and commands for all platforms - changelog entries Code: - Fmi3UpdateDiscreteStatesResult used discreteStateNeedsUpdate and nominalsOfContinuousStatesChanged, but the wrapper reads the FMI names discreteStatesNeedUpdate / nominalContinuousStatesChanged, so both flags were silently ignored. Rename to the FMI names; keep the old ones as aliases. Tests: test_docs now checks every documented model (all variables readable, inputs/parameters settable, model description builds), covers index.md, and skips instead of failing when run from an installed package. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X8Wmw797DJpgrMFmT6n8CG
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.
Docs:
pythonfmu3 buildoptions, missing imports in the MX exampleCode:
Tests: test_docs now checks every documented model (all variables readable, inputs/parameters settable, model description builds), covers index.md, and skips instead of failing when run from an installed package.