Documentation updates: Explanation section rewrites and docstring updates#1635
Open
jbrossman wants to merge 75 commits into
Open
Documentation updates: Explanation section rewrites and docstring updates#1635jbrossman wants to merge 75 commits into
jbrossman wants to merge 75 commits into
Conversation
added 9 commits
February 17, 2026 15:17
…per_unit explanation for transformers
Changed accessor and getter language across multiple pages
Edits include deleting the original supplemental attributes explanation, and creating a new one. Then, adding in two how tos, which describe how to add supplemental attributes and then a second how to about querying the supplemental attributes to get additional information. Update the glossary with UUID description as well.
First edits to system explanation and a new how-to. Also edited the make.jl file to include previously committed files and these new files.
Key changes include adding @id references to the tutorials, referencing those tutorials in the explanation, and creating a separate how-to using code originally featured in the system explanation.
Successfully compiled the documentation and fixed a number of issues. Most of them were for broken or missing references.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1635 +/- ##
==========================================
+ Coverage 84.13% 84.15% +0.02%
==========================================
Files 204 204
Lines 10540 10536 -4
==========================================
- Hits 8868 8867 -1
+ Misses 1672 1669 -3
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
Contributor
|
@jbrossman I haven't taken a look yet, but FYI, about figures there's a different file path to get it to show up locally versus on github ("../" vs. "../../" or vice versa). We will want whichever one gets it to show up on the github Preview, so don't worry about it if it doesn't show up locally |
added 4 commits
March 2, 2026 14:09
Edits to Power Concepts including a new and more built out how-to
Mostly reorganizing the information
kdayday
reviewed
Mar 3, 2026
kdayday
reviewed
Mar 3, 2026
kdayday
reviewed
Mar 3, 2026
kdayday
reviewed
Mar 3, 2026
kdayday
reviewed
Mar 3, 2026
kdayday
reviewed
Mar 3, 2026
added 6 commits
March 3, 2026 08:28
Edits to use_subsystems.md to get an error free example, word changes, and reference links.
Julia blocks changed to REPL blocks, additional references added, and further explanation about data storage.
Key changes include additional references, describing what a dynamic device is, taking out the images that originally appeared, and more clearly linking the ideas between the sections.
Remove @id tags in tutorials, and update any references to these tutorials to use the title instead.
Search and edit how_to folder to convert all '''julia code blocks to use the '''repl formatting instead.
Copilot
AI
changed the title
Jb/documentation updates
Documentation updates: migrate enumerated type docs into scoped enum docstrings
Jun 2, 2026
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: kdayday <kdayday@users.noreply.github.com>
…raph Co-authored-by: Cursor <cursoragent@cursor.com>
Restore main signatures, exports, tests, and subsystem API while keeping expanded subsystem docstrings without the new check_subsystems(System) entrypoint. Co-authored-by: Cursor <cursoragent@cursor.com>
Update generated dynamic model docstrings and descriptor comments to use @ref PrimeMovers, ThermalFuels, ACBusTypes, and StateTypes instead of removed enumerated_types.md subsection anchors. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
…butes Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 93 out of 135 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (4)
src/subsystems.jl:1
- Typo in the error message string:
subystems→subsystems. This message can surface to users, so it should be corrected.
src/models/static_models.jl:1 error(ArgumentError(...))throws anErrorException(stringifies theArgumentError) rather than throwing theArgumentErroritself. Usethrow(ArgumentError(...))so callers can reliably catchArgumentErrorand so the exception type matches the message.
docs/src/how_to/use_subsystems.md:1- This admonition is currently commented out with leading
#, so it will render as literal text instead of a!!! noteblock. Remove the#prefixes and indent the body under!!! noteto make Documenter render the note correctly.
docs/src/tutorials/working_with_time_series.jl:1 - The previous explicit page anchor
(@id tutorial_time_series)was removed. Relying on title-based@reftargets is more fragile (title changes break links). Consider restoring a stable@idon the header (even if you also link by title) to keep references resilient.
| ] | ||
| Order = [:type, :function] | ||
| Filter = t -> nameof(t) in names(PowerSystems) | ||
| Filter = t -> typeof(t) !== Union && applicable(nameof, typeof(t)) && nameof(t) in names(PowerSystems) |
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.
This pull request makes several improvements to the documentation build configuration for the project. The main changes include expanding the set of external fallback references for InfrastructureSystems types and functions, restructuring and adding new documentation pages for better organization and coverage, and removing the now-obsolete enumerated types API documentation.
Documentation improvements and organization:
ExternalFallbacksindocs/make.jlto include additional InfrastructureSystems types and functions such asadd_supplemental_attribute!,remove_supplemental_attribute!,ComponentUUIDs,PiecewiseLinearData,SupplementalAttributeManager,SystemData,TimeSeriesManager, and more, improving cross-referencing in docstrings.docs/make.jlby splitting the "add additional data to a component" section into multiple focused pages, and added new how-to guides for unit system conversions, transformer impedance conversion, and using subsystems.api/enumerated_types.mdpage and its reference from the documentation navigation, as well as the "transformer_per_unit_models.md" and "enumerated_types.md" entries, reflecting a cleanup and update of outdated or redundant content. [1] [2] [3]These changes enhance the usability and maintainability of the documentation by providing more comprehensive references and a clearer, more organized structure.## Description
This PR updates and tightens documentation content and cross-references, with a focused migration of enumerated type documentation from the standalone API page into the scoped enum docstrings in
src/definitions.jl.In addition to the broader docstring and docs cleanup work already in this PR, the latest updates:
@ref pm_list) with direct enum docstring references (e.g.,@ref PrimeMovers) across docs/generated docs,docs/src/api/enumerated_types.md,docs/make.jlto remove the old enumerated-types page from navigation.No new functionality was introduced; these are documentation and reference-structure updates.
Related Issue
This is follow-up documentation work aligned with the existing documentation improvement scope in this PR.
Closes #1504
Closes #1457
Closes #1448
New Structs
Not applicable — no new structs were added.