Skip to content

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

Merged
PProfizi merged 6 commits into
masterfrom
example/create-readme-for-new-folder
Jan 28, 2025
Merged

Add a README file to the "mathematical operations" examples folder#1874
PProfizi merged 6 commits into
masterfrom
example/create-readme-for-new-folder

Conversation

@luisaFelixSalles

Copy link
Copy Markdown
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
@codecov

codecov Bot commented Nov 7, 2024

Copy link
Copy Markdown

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

PProfizi commented Nov 7, 2024

Copy link
Copy Markdown
Contributor

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.

@PProfizi PProfizi left a comment

Copy link
Copy Markdown
Contributor

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

Comment thread examples/16-maths-ops/01-matrix-operations.py Outdated
Comment thread examples/01-mathematical-operations/README.text Outdated
Comment thread examples/16-maths-ops/01-matrix-operations.py
Comment thread examples/16-maths-ops/README.text Outdated
Comment thread examples/16-maths-ops/01-matrix-operations.py Outdated

@PProfizi PProfizi left a comment

Copy link
Copy Markdown
Contributor

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
@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