- 
          
- 
                Notifications
    You must be signed in to change notification settings 
- Fork 233
Add missing API documentation for all exported symbols #3887
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Merged
      
      
            ChrisRackauckas
  merged 3 commits into
  SciML:master
from
ChrisRackauckas-Claude:add-missing-api-docs
  
      
      
   
  Aug 12, 2025 
      
    
  
     Merged
                    Changes from 1 commit
      Commits
    
    
            Show all changes
          
          
            3 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      
    File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      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
    
  
  
    
              
  
    
      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
    
  
  
    
              
  
    
      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
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # Bipartite Graphs | ||
|  | ||
| ModelingToolkit uses bipartite graphs to represent relationships between equations and variables in systems. These functions provide tools for working with and analyzing these graphs. | ||
|  | ||
| ## Graph Types | ||
|  | ||
| ```@docs | ||
| BipartiteGraph | ||
| BipartiteEdge | ||
| DiCMOBiGraph | ||
| DiffGraph | ||
| ``` | ||
|  | ||
| ## Vertex Operations | ||
|  | ||
| ```@docs | ||
| 𝑠vertices | ||
| 𝑑vertices | ||
| has_𝑠vertex | ||
| has_𝑑vertex | ||
| nsrcs | ||
| ndsts | ||
| ``` | ||
|  | ||
| ## Neighbor Operations | ||
|  | ||
| ```@docs | ||
| 𝑠neighbors | ||
| 𝑑neighbors | ||
| set_neighbors! | ||
| ``` | ||
|  | ||
| ## Edge Operations | ||
|  | ||
| ```@docs | ||
| 𝑠edges | ||
| 𝑑edges | ||
| ``` | ||
|  | ||
| ## Graph Views and Modifications | ||
|  | ||
| ```@docs | ||
| invview | ||
| delete_srcs! | ||
| delete_dsts! | ||
| ``` | ||
|  | ||
| ## Matching Algorithms | ||
|  | ||
| ```@docs | ||
| maximal_matching | ||
| construct_augmenting_path! | ||
| ``` | ||
|  | ||
| ## Dependency Analysis | ||
|  | ||
| ```@docs | ||
| equation_dependencies | ||
| variable_dependencies | ||
| eqeq_dependencies | ||
| varvar_dependencies | ||
| map_variables_to_equations | ||
| ``` | ||
|  | ||
| ## Graph Conversion | ||
|  | ||
| ```@docs | ||
| asgraph | ||
| asdigraph | ||
| ``` | ||
|  | ||
| ## Constants | ||
|  | ||
| ```@docs | ||
| SRC | ||
| DST | ||
| ``` | 
  
    
      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
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| # Structural Transformation | ||
|  | ||
| These functions are used for structural analysis and transformation of equation systems, including index reduction, tearing, and other algebraic manipulations used in the simplification process. | ||
|  | ||
| ## Tearing and Algebraic Simplification | ||
|  | ||
| ```@docs | ||
| tearing | ||
| tearing_reassemble | ||
| tearing_substitution | ||
| torn_system_jacobian_sparsity | ||
| find_solvables! | ||
| linear_subsys_adjmat! | ||
| ``` | ||
|  | ||
| ## Index Reduction | ||
|  | ||
| ```@docs | ||
| dae_index_lowering | ||
| pantelides! | ||
| pantelides_reassemble | ||
| dummy_derivative | ||
| ``` | ||
|  | ||
| ## Consistency Checking | ||
|  | ||
| ```@docs | ||
| check_consistency | ||
| ``` | ||
|  | ||
| ## Incidence Matrix Operations | ||
|  | ||
| ```@docs | ||
| sorted_incidence_matrix | ||
| but_ordered_incidence | ||
| ``` | ||
|  | ||
| ## Variable Ordering and Masks | ||
|  | ||
| ```@docs | ||
| lowest_order_variable_mask | ||
| highest_order_variable_mask | ||
| computed_highest_diff_variables | ||
| ``` | ||
|  | ||
| ## Shift Operations | ||
|  | ||
| These functions handle shift operations in discrete-time systems. | ||
|  | ||
| ```@docs | ||
| shift2term | ||
| lower_shift_varname | ||
| simplify_shifts | ||
| distribute_shift | ||
| ``` | ||
|  | ||
| ## System Structure Types and Functions | ||
|  | ||
| ```@docs | ||
| SystemStructure | ||
| TearingState | ||
| TransformationState | ||
| isdiffvar | ||
| isdervar | ||
| isalgvar | ||
| isdiffeq | ||
| algeqs | ||
| is_only_discrete | ||
| dervars_range | ||
| diffvars_range | ||
| algvars_range | ||
| get_fullvars | ||
| system_subset | ||
| ``` | ||
|  | ||
| ## Graph Types | ||
|  | ||
| ```@docs | ||
| Matching | ||
| InducedCondensationGraph | ||
| MatchedCondensationGraph | ||
| Unassigned | ||
| unassigned | ||
| ``` | 
      
      Oops, something went wrong.
        
    
  
  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.
  
    
  
    
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's missing the most fundamental
linearizeandlinearization_function?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is actually a dup.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The point of API pages is typically that they contain the entire API, even if some things happen to be documented elsewhere as well.