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.

Sign up for GitHub

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

Jump to bottom

Add docstrings with help from copilot #52

Merged
merged 10 commits into from
Aug 2, 2024
Merged

Add docstrings with help from copilot #52

merged 10 commits into from
Aug 2, 2024

Conversation

StephanieKemna
Copy link
Collaborator

Resolves #32

@StephanieKemna StephanieKemna added the documentation Improvements or additions to documentation label Jul 24, 2024
@StephanieKemna StephanieKemna self-assigned this Jul 24, 2024
@StephanieKemna StephanieKemna linked an issue Jul 24, 2024 that may be closed by this pull request
Write missing documentation strings for functions and classes #32
Closed
Jorgelmh
Jorgelmh approved these changes Jul 25, 2024
View reviewed changes
Copy link
Collaborator

@Jorgelmh Jorgelmh left a comment

Choose a reason for hiding this comment

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

Some slight changes in the wording to make it clearer

@StephanieKemna
Copy link
Collaborator Author

Some slight changes in the wording to make it clearer

Thank you 😊 I will leave this one open for Kristoffer to review as well.

KristofferSkare
KristofferSkare reviewed Jul 30, 2024
View reviewed changes
src/mlfmu/api.py Outdated Show resolved Hide resolved
KristofferSkare
KristofferSkare reviewed Jul 30, 2024
View reviewed changes
src/mlfmu/fmu_build/templates/fmu/fmu_template.cpp
Copy link
Collaborator

Choose a reason for hiding this comment

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

This file is a bit weird since it is a template string file and a cpp file at the same time. I see that some linting has made some changes that I think breaks its use as a template string. I suggest some changes below to fix it

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ok, suggestions accepted, and template/examples removed. Let me know if there's more!

Thanks for making the suggestions as you did, it was super easy to just accept/commit those :)

src/mlfmu/fmu_build/templates/fmu/fmu_template.cpp Outdated Show resolved Hide resolved
src/mlfmu/fmu_build/templates/fmu/fmu_template.cpp Outdated Show resolved Hide resolved
src/mlfmu/fmu_build/templates/fmu/fmu_template.cpp Outdated Show resolved Hide resolved
src/mlfmu/fmu_build/templates/onnx_fmu/onnxFmu.cpp Outdated Show resolved Hide resolved
StephanieKemna and others added 5 commits August 1, 2024 13:39
@StephanieKemna @KristofferSkare
Update src/mlfmu/fmu_build/templates/fmu/fmu_template.cpp
1a30427 
undo linting, fix templating, Kristoffer's suggestion

Co-authored-by: KristofferSkare <[email protected]>
@StephanieKemna @KristofferSkare
Update src/mlfmu/fmu_build/templates/fmu/fmu_template.cpp
91a103a 
undo linting, fix templating, Kristoffer's suggestion

Co-authored-by: KristofferSkare <[email protected]>
@StephanieKemna @KristofferSkare
Update src/mlfmu/fmu_build/templates/fmu/fmu_template.cpp
6ffef30 
undo linting, fix templating, Kristoffer's suggestion

Co-authored-by: KristofferSkare <[email protected]>
@StephanieKemna @KristofferSkare
Update src/mlfmu/fmu_build/templates/onnx_fmu/onnxFmu.cpp
a0699d6 
Kristoffer's suggested rewrite

Co-authored-by: KristofferSkare <[email protected]>
@StephanieKemna
remove examples from python package template, which are not used
a50a6bd
@StephanieKemna StephanieKemna merged commit 3734eed into main Aug 2, 2024
11 checks passed
@StephanieKemna StephanieKemna deleted the 32-write-missing-documentation-strings branch November 8, 2024 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KristofferSkare KristofferSkare KristofferSkare approved these changes

@Jorgelmh Jorgelmh Jorgelmh approved these changes

Assignees

@StephanieKemna StephanieKemna

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Write missing documentation strings for functions and classes
3 participants
@StephanieKemna @Jorgelmh @KristofferSkare