Skip to content

docs: for functions module - #163

Merged
sbillinge merged 4 commits into
diffpy:mainfrom
yucongalicechen:functions-docs
Feb 1, 2025
Merged

docs: for functions module#163
sbillinge merged 4 commits into
diffpy:mainfrom
yucongalicechen:functions-docs

Conversation

@yucongalicechen

@yucongalicechenyucongalicechen commented Jan 31, 2025

Copy link
Copy Markdown
Collaborator

closes#157
@sbillinge ready for review

@codecov

codecovBot commented Jan 31, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.21%. Comparing base (8ef887c) to head (c3f19d8).
Report is 16 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #163 +/- ##
=======================================
Coverage 99.21% 99.21% =======================================
Files 5 5 Lines 254 254 =======================================
Hits 252 252 Misses 2 2 

see 4 files with indirect coverage changes

plt.title("Original vs. Corrected Intensity")
plt.show()

4. You can modify the global parameters

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

For this section, I'm wondering if I should add these parameters in the brute force computation function, e.g.,
compute_cve(input_pattern, mud, method="polynomial_interpolation", xtype="tth", n_points_on_diameter=None, tth_grid=None)
so that people can edit these without modifying the global parameters. This is probably uncommon so we don't need to modify anything in the main app.

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.

This would make this more general and so better. However, for things like this we may want to wait until someone asks for it and then do it? Maybe put it as a feature request in the issues so we don't forget? We could create a milestone which is a holding place for feature requests, and we can move them to a release milestone when someone requiests it and we decide we want to do it?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Sounds great, I'll do that!

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

It seems that I can't add a new milestone.. but I created an issue for this

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

please see comment. I will merge this because documentation is easier to review when it is built, but @yucongalicechen please read and act on the comment.

plt.title("Original vs. Corrected Intensity")
plt.show()

4. You can modify the global parameters

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.

This would make this more general and so better. However, for things like this we may want to wait until someone asks for it and then do it? Maybe put it as a feature request in the issues so we don't forget? We could create a milestone which is a holding place for feature requests, and we can move them to a release milestone when someone requiests it and we decide we want to do it?

@sbillinge
sbillinge merged commit 270127c into diffpy:mainFeb 1, 2025
@yucongalicechen
yucongalicechen deleted the functions-docs branch February 3, 2025 20:56
Sign up for freeto 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.

docs: functions module

2 participants

@yucongalicechen@sbillinge