Documentation updates: Explanation section rewrites and docstring updates#1635
Merged
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.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 111 out of 169 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (4)
src/utils/print.jl:1
- The
component_typeargument type annotation is malformed Markdown/Documenter syntax (Type{<:Component}) and is likely to render incorrectly (or break doc builds). Prefer keeping the type expression as code (Type{<:Component}) and add theComponentlink outside the braces, e.g. 'Type to display (Type{<:Component}); seeComponent'.
src/parsers/powerflowdata_data.jl:1 - The type annotation mixes backticks, braces, and
@refin a way that is hard to read and may render poorly. Consider simplifying the signature documentation to standard Julia syntax (e.g.,Union{PowerFlowDataNetwork, String, IO}) and referencePowerFlowDataNetworkin the prose instead of embedding the link inside the type expression.
src/models/branches.jl:1 - These docstrings state the endpoints are
ACBus, butBranchcan include DC branches (endpoints areDCBus) and potentially other branch-like components. To avoid misleading users, describe the endpoints as a generic bus/topology node (e.g.,Bus) or explicitly document what endpoint types are supported for each branch subtype.
docs/src/tutorials/manipulating_datasets.jl:1 - This inline link/code combination will render awkwardly (
[ThermalFuels](@ref).NATURAL_GAS``). Prefer a single code span likeThermalFuels.NATURAL_GASand (optionally) link `ThermalFuels` separately, e.g. 'updated to `ThermalFuels.NATURAL_GAS` (see `ThermalFuels`)'.
Comment on lines
+15
to
+16
| These categories are are all subtypes of [`TimeSeriesData`](@ref) and fall within this time series | ||
| [type hierarchy](@ref type_structure): |
Merged
jd-lara
approved these changes
Jun 12, 2026
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.
Depends on Sienna-Platform/InfrastructureSystems.jl#584
This pull request updates the documentation structure and navigation for PowerSystems.jl, improving organization, adding new topics, and aligning links with updated content locations. The changes focus on enhancing the developer and user experience by expanding references, reorganizing how-to guides, and updating documentation paths.
Documentation structure and navigation improvements:
reference/directory instead ofapi/for public API, glossary, type tree, and developer/internal documentation, reflecting a new documentation structure.Reference and fallback improvements:
ExternalFallbacksindocs/make.jlto include more InfrastructureSystems references, improving cross-linking and reducing documentation build errors for missing references.Minor updates:
reference/developer_guidelineslocation.No new functionality was introduced; these are documentation and reference-structure updates.
Related Issue
Closes #1504
Closes #1457
Closes #1448
Closes #1461
New Exports
HydroUnitis exported (oversight)