Skip to content

Improve COMPARTMENT documentation.#2771

Merged
alkino merged 1 commit into
masterfrom
1uc/improve-compartment-doc
Apr 10, 2024
Merged

Improve COMPARTMENT documentation.#2771
alkino merged 1 commit into
masterfrom
1uc/improve-compartment-doc

Conversation

@1uc

@1uc 1uc commented Mar 6, 2024

Copy link
Copy Markdown
Collaborator

The documentation for the non-indexed COMPARTMENT is clear to me. For the indexed variant, it wasn't clear if the state variable should be an array variable, e.g. s, or an indexed array variable, i.e. s[i]. Similar in the volume expression: are array variables automatically detected and the [i] is added automatically during codegen.

This PR hopes to clarifies those two points.

@1uc 1uc force-pushed the 1uc/improve-compartment-doc branch from fef8327 to 7b43755 Compare March 6, 2024 15:37
@1uc

1uc commented Mar 6, 2024

Copy link
Copy Markdown
Collaborator Author

Locally a9cb398 renders as follows:

compartment_docs

@1uc 1uc force-pushed the 1uc/improve-compartment-doc branch from 7b43755 to a9cb398 Compare March 6, 2024 15:43
@sonarqubecloud

sonarqubecloud Bot commented Mar 6, 2024

Copy link
Copy Markdown

Please retry analysis of this Pull-Request directly on SonarCloud

@1uc 1uc marked this pull request as ready for review March 6, 2024 16:34
@azure-pipelines

Copy link
Copy Markdown

✔️ a9cb398 -> Azure artifacts URL

@bbpbuildbot

This comment has been minimized.

@alkino alkino closed this Apr 9, 2024
@alkino alkino reopened this Apr 9, 2024
@alkino alkino enabled auto-merge (squash) April 9, 2024 20:12
@sonarqubecloud

sonarqubecloud Bot commented Apr 9, 2024

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@azure-pipelines

Copy link
Copy Markdown

✔️ a9cb398 -> Azure artifacts URL

@codecov

codecov Bot commented Apr 10, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.80%. Comparing base (8afc9de) to head (a9cb398).
Report is 35 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2771      +/-   ##
==========================================
+ Coverage   66.91%   67.80%   +0.88%     
==========================================
  Files         560      562       +2     
  Lines      104093   108370    +4277     
==========================================
+ Hits        69659    73485    +3826     
- Misses      34434    34885     +451     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@alkino alkino merged commit 2b928ad into master Apr 10, 2024
@alkino alkino deleted the 1uc/improve-compartment-doc branch April 10, 2024 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants