Open
Conversation
Adds docstrings for 49 exported types and functions that were missing them, including dynamic generator/inverter component abstract types (AVR, Machine, PSS, Shaft, TurbineGov, Converter, DCSource, Filter, FrequencyEstimator, InnerControl, OutputCurrentLimiter), reserve types, contingency types, scoped enums (StateTypes, CombinedCycleConfiguration), accessor functions, and utility functions. Uses @doc macro for @scoped_enum types. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
11 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1632 +/- ##
=======================================
Coverage 84.03% 84.03%
=======================================
Files 203 203
Lines 10462 10462
=======================================
Hits 8792 8792
Misses 1670 1670
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
Adds contingencies.jl, parsers/im_io/matlab.jl, and supplemental_setters.jl to the appropriate @autodocs sections so their new docstrings are included in the built documentation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
Author
|
The docs test errors because it's using the current version of IS, which lacks a docstring for |
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
1 participant
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.
Summary
AVR,Machine,PSS,Shaft,TurbineGovConverter,DCSource,Filter,FrequencyEstimator,InnerControl,OutputCurrentLimiterAbstractReserve,ReserveNonSpinning,Contingency,Outage,PowerPlantServiceContributingDevices,TurbineConnectedDevicesStateTypes,CombinedCycleConfiguration(uses@docmacro)get_machine,get_shaft,get_avr,get_prime_mover,get_pss,get_frequency_droop,get_converter,get_outer_control,get_inner_control,get_dc_source,get_freq_estimator,get_filteris_market_bid_curve,set_upstream_turbine!,set_downstream_turbine!,remove_component_from_subsystems!,get_component_uuids,remove_components!,check_ac_transmission_rate_values,parse_matlab_file,parse_matlab_string@reflinks for cross-referencing in built documentationTest plan
🤖 Generated with Claude Code