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

Improve formatting component modeling documentation #439

Merged
merged 15 commits into from Dec 11, 2023

Conversation

zhen0427
Copy link
Contributor

@zhen0427 zhen0427 commented Nov 27, 2023

Signed-off-by: Zhen Wang <zhen.wang@alliander.com>
@mgovers mgovers changed the title another version Improve formatting component modeling documentation Nov 27, 2023
docs/user_manual/components.md Outdated Show resolved Hide resolved
docs/user_manual/components.md Show resolved Hide resolved
docs/user_manual/components.md Outdated Show resolved Hide resolved
docs/user_manual/components.md Show resolved Hide resolved
@mgovers
Copy link
Member

mgovers commented Nov 27, 2023

only semi-related to this PR, but the docs for each of the components are becoming fairly large. Do you think it would be a good idea to collapse/expand sections? documentation on how to add that in https://sphinx-toolbox.readthedocs.io/en/stable/extensions/collapse.html

Signed-off-by: Zhen Wang <zhen.wang@alliander.com>
docs/user_manual/components.md Outdated Show resolved Hide resolved
docs/user_manual/components.md Outdated Show resolved Hide resolved
docs/user_manual/components.md Outdated Show resolved Hide resolved
Signed-off-by: Zhen Wang <zhen.wang@alliander.com>
@nitbharambe
Copy link
Member

nitbharambe commented Nov 30, 2023

Is this DCO remediation broken? :(
I tried multiple times now.

zhen0427 and others added 4 commits November 30, 2023 14:53
Signed-off-by: Zhen Wang <zhen.wang@alliander.com>
Signed-off-by: Zhen Wang <zhen.wang@alliander.com>
Signed-off-by: Zhen Wang <zhen.wang@alliander.com>
DCO Remediation Commit for Nitish Bharambe <78108900+nitbharambe@users.noreply.github.com>

I, Nitish Bharambe <78108900+nitbharambe@users.noreply.github.com>, hereby add my Signed-off-by to this commit: 6a118e5

Signed-off-by: Nitish Bharambe <78108900+nitbharambe@users.noreply.github.com>
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>

DCO Remediation Commit for Nitish Bharambe <78108900+nitbharambe@users.noreply.github.com>

I, Nitish Bharambe <78108900+nitbharambe@users.noreply.github.com>, hereby add my Signed-off-by to this commit: 6a118e5

Signed-off-by: Nitish Bharambe <78108900+nitbharambe@users.noreply.github.com>
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>

DCO Remediation Commit for Nitish Bharambe <nitish.bharambe@alliander.com>

I, Nitish Bharambe <nitish.bharambe@alliander.com>, hereby add my Signed-off-by to this commit: 6a118e5

Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>

remediation final try

DCO Remediation Commit for Nitish Bharambe <78108900+nitbharambe@users.noreply.github.com>

I, Nitish Bharambe <78108900+nitbharambe@users.noreply.github.com>, hereby add my Signed-off-by to this commit: 6a118e5

Signed-off-by: Nitish Bharambe <78108900+nitbharambe@users.noreply.github.com>
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
nitbharambe
nitbharambe previously approved these changes Dec 4, 2023
Copy link
Member

@mgovers mgovers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only 1 nitpick and 1 comment that you may close yourself if you don't agree with it

docs/user_manual/components.md Outdated Show resolved Hide resolved
docs/user_manual/components.md Show resolved Hide resolved
nitbharambe and others added 2 commits December 4, 2023 14:18
Signed-off-by: Nitish Bharambe <78108900+nitbharambe@users.noreply.github.com>
docs/user_manual/components.md Show resolved Hide resolved
docs/user_manual/components.md Outdated Show resolved Hide resolved
nitbharambe and others added 4 commits December 11, 2023 14:52
Signed-off-by: Nitish Bharambe <78108900+nitbharambe@users.noreply.github.com>
Signed-off-by: Zhen Wang <zhen.wang@alliander.com>
Signed-off-by: Zhen Wang <zhen.wang@alliander.com>
Signed-off-by: Nitish Bharambe <78108900+nitbharambe@users.noreply.github.com>
Signed-off-by: Nitish Bharambe <78108900+nitbharambe@users.noreply.github.com>
Copy link

sonarcloud bot commented Dec 11, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@nitbharambe nitbharambe self-requested a review December 11, 2023 14:40
@mgovers mgovers merged commit 4352087 into main Dec 11, 2023
27 checks passed
@mgovers mgovers deleted the feature/document-modeling branch December 11, 2023 15:30
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.

[FEATURE] Document modelling of components
3 participants