Skip to content
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

Updating documentation #102

Merged
merged 3 commits into from
Sep 8, 2023
Merged

Conversation

AnHeuermann
Copy link
Member

Some improvements for the documentation.

Docstrings are now helpfull without the online documentation:

Old:

help?> OMJulia.showQuantities
  standard getXXX() API function same as getQuantities(), but returns all the variables as table

New:

help?> OMJulia.showQuantities
  showQuantities(omc, name=nothing)

  Return DataFrame of all variables parsed from xml file.

  Arguments
  ===========

    •  omc::OMCSession: OpenModelica compiler session.

    •  name::Union{<:AbstractString, Array{<:AbstractString,1}, Nothing}: Name(s) of variables to read from xml file. If nothing is provided read all variables.

  See also getQuantities.

Related Issues

Fixes #87, fixes #85.

Changes

  • Adding types to function interfaces
  • Adding types to structs
  • Refactoring OMCSession into multiple structs
  • Document get and set methods
  • Simplifying if statements, removing brackets
  • Changing prints to @error or @info

  - Adding types to function interfaces
  - Adding types to structs
  - Refactoring OMCSession into multiple structs
  - Document get and set methods
  - Simplifying if statements, removing brackets
  - Changing prints to @error or @info
@AnHeuermann AnHeuermann self-assigned this Sep 7, 2023
@AnHeuermann
Copy link
Member Author

@arun3688 I made a lot of changes to all the interfaces. Can you have a short look at it? I hope the CI will catch most errors, but we don't test the API functions very well.

@AnHeuermann AnHeuermann linked an issue Sep 7, 2023 that may be closed by this pull request
@AnHeuermann AnHeuermann merged commit 75619cf into OpenModelica:master Sep 8, 2023
4 checks passed
@AnHeuermann AnHeuermann deleted the improve-doc branch September 8, 2023 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant