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

Add a README file to the "mathematical operations" examples folder #1874

Merged
merged 6 commits into from
Jan 28, 2025

Conversation

luisaFelixSalles
Copy link
Contributor

This PR allows this example section to be shown in the documentation

@luisaFelixSalles luisaFelixSalles added the examples Related to PyDPF-Core examples label Nov 7, 2024
@luisaFelixSalles luisaFelixSalles self-assigned this Nov 7, 2024
@PProfizi PProfizi changed the title Add README.ttxt file to the "mathematical operations" examples folder Add a README file to the "mathematical operations" examples folder Nov 7, 2024
Copy link

codecov bot commented Nov 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.62%. Comparing base (17bc61f) to head (b8090b1).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1874      +/-   ##
==========================================
+ Coverage   87.51%   88.62%   +1.10%     
==========================================
  Files          90       90              
  Lines       10220    10220              
==========================================
+ Hits         8944     9057     +113     
+ Misses       1276     1163     -113     

@PProfizi
Copy link
Contributor

PProfizi commented Nov 7, 2024

Hey @luisaFelixSalles, the example ends-up mixed with basic examples
image

I think you need to renumber the folder for mathematical examples or something like that.

Copy link
Contributor

@PProfizi PProfizi left a comment

Choose a reason for hiding this comment

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

See comment about example ending-up with basic examples

examples/16-maths-ops/01-matrix-operations.py Outdated Show resolved Hide resolved
examples/01-mathematical-operations/README.text Outdated Show resolved Hide resolved
examples/16-maths-ops/01-matrix-operations.py Show resolved Hide resolved
examples/16-maths-ops/README.text Outdated Show resolved Hide resolved
Copy link
Contributor

@PProfizi PProfizi left a comment

Choose a reason for hiding this comment

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

Doc renders correctly

@PProfizi PProfizi merged commit 77cac38 into master Jan 28, 2025
46 checks passed
@PProfizi PProfizi deleted the example/create-readme-for-new-folder branch January 28, 2025 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
examples Related to PyDPF-Core examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants