docs: fix assorted issues#2295
Open
triceo wants to merge 1 commit intoTimefoldAI:mainfrom
Open
Conversation
This was
linked to
issues
May 10, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation examples to reflect the current Domain MetaModel/Neighborhoods API method names and to simplify some admonition formatting in the optimization algorithms docs.
Changes:
- Update Neighborhoods API examples to use
genuineEntity(...).basicVariable(...)instead of older entity/variable accessors. - Convert several AsciiDoc NOTE blocks into inline
NOTE:admonition paragraphs and add guidance thatSelectionFilterimplementations are stateless. - Minor formatting tweak (blank line) around a section boundary in the move selector reference.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/src/modules/ROOT/pages/optimization-algorithms/neighborhoods.adoc | Updates Domain MetaModel example code to the current genuineEntity/basicVariable API. |
| docs/src/modules/ROOT/pages/optimization-algorithms/move-selector-reference.adoc | Adjusts filtering documentation/admonitions and modifies the SelectionFilter example code (currently incorrect). |
|
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.
No description provided.