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

docs: Inprovement of the material mapping how-to #1051

Merged

Conversation

Corentin-Allaire
Copy link
Contributor

This PR improves the material mapping how-to. It provided context on what material mapping is and why is it needed, gives some pointer to how the map should be configured and explain that in the case of DD4Hep the config is not always needed (this should resolve #899 ).

@Corentin-Allaire Corentin-Allaire added this to the next milestone Oct 22, 2021
@Corentin-Allaire Corentin-Allaire added the Component - Documentation Affects the documentation label Oct 22, 2021
@codecov
Copy link

codecov bot commented Oct 22, 2021

Codecov Report

Merging #1051 (4f91433) into main (b3df2b9) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1051   +/-   ##
=======================================
  Coverage   48.57%   48.57%           
=======================================
  Files         338      338           
  Lines       17343    17343           
  Branches     8200     8200           
=======================================
  Hits         8425     8425           
  Misses       3180     3180           
  Partials     5738     5738           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b3df2b9...4f91433. Read the comment docs.

Copy link
Member

@paulgessinger paulgessinger left a comment

Choose a reason for hiding this comment

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

I added few typo-fixes / suggestions.

docs/examples/howto/run_material_mapping.rst Outdated Show resolved Hide resolved
docs/examples/howto/run_material_mapping.rst Outdated Show resolved Hide resolved
docs/examples/howto/run_material_mapping.rst Outdated Show resolved Hide resolved
docs/examples/howto/run_material_mapping.rst Outdated Show resolved Hide resolved
docs/examples/howto/run_material_mapping.rst Outdated Show resolved Hide resolved
docs/examples/howto/run_material_mapping.rst Outdated Show resolved Hide resolved
@Corentin-Allaire
Copy link
Contributor Author

@paulgessinger since I implemented your changes I think you need to reapprove.

@paulgessinger paulgessinger changed the title fix: Inprovement of the material mapping how-to docs: Inprovement of the material mapping how-to Oct 26, 2021
@paulgessinger paulgessinger merged commit 38a2d45 into acts-project:main Oct 26, 2021
@paulgessinger paulgessinger modified the milestones: next, v15.0.0 Nov 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Documentation Affects the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Material mapping example is broken
2 participants