Skip to content

Change objective and reference naming#74

Merged
sbillinge merged 4 commits into
diffpy:mainfrom
Sparks29032:rework_documentation
Jun 18, 2023
Merged

Change objective and reference naming#74
sbillinge merged 4 commits into
diffpy:mainfrom
Sparks29032:rework_documentation

Conversation

@Sparks29032

Copy link
Copy Markdown
Collaborator

Fixes #37. Fixes #46. Fixes #55.

@codecov

codecov Bot commented Jun 18, 2023

Copy link
Copy Markdown

Codecov Report

Merging #74 (fb534ef) into main (71e52e5) will decrease coverage by 0.20%.
The diff coverage is 85.49%.

@@            Coverage Diff             @@
##             main      #74      +/-   ##
==========================================
- Coverage   74.15%   73.96%   -0.20%     
==========================================
  Files          35       35              
  Lines        1389     1398       +9     
==========================================
+ Hits         1030     1034       +4     
- Misses        359      364       +5     
Impacted Files Coverage Δ
diffpy/pdfmorph/pdfmorphapp.py 26.94% <12.50%> (+1.01%) ⬆️
diffpy/pdfmorph/morphs/morphishape.py 65.51% <33.33%> (ø)
diffpy/pdfmorph/morphs/morphshift.py 68.75% <42.85%> (ø)
diffpy/pdfmorph/tools.py 72.54% <61.53%> (-7.46%) ⬇️
diffpy/pdfmorph/refine.py 76.00% <70.00%> (ø)
diffpy/pdfmorph/morphs/morphrdftopdf.py 90.00% <81.81%> (ø)
diffpy/pdfmorph/morphs/morph.py 76.00% <85.18%> (ø)
diffpy/pdfmorph/pdfmorph_api.py 90.24% <85.71%> (ø)
diffpy/pdfmorph/morphs/morphchain.py 92.10% <100.00%> (ø)
diffpy/pdfmorph/morphs/morphpdftordf.py 100.00% <100.00%> (ø)
... and 19 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Comment on lines +181 to +198
group.add_option(
'--usefilenames',
action="store_true",
dest="usefilenames",
help="Use the file names as labels on plot."
)
group.add_option(
'--mlabel',
metavar="MLABEL",
dest="mlabel",
help="Set label for morphed data to MLABEL on plot. Ignored if using file names as labels.",
)
group.add_option(
'--tlabel',
metavar="TLABEL",
dest="tlabel",
help="Set label for target data to TLABEL on plot. Ignored if using file names as labels.",
)

@Sparks29032 Sparks29032 Jun 18, 2023

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

New option to set label names on plot (for fixing #46).

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.

looks good, see comment. Please put different issues on different PRs

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

Changes look great, thanks!

Please see quick inline comments and I can merge.

Please put less on each PR to make it easier to review and merge. One thing per branch/pr ideally. If something is a quick cleaning thing you can add it to another one, but this should have been at least two PRs if not three.

Thanks so much

Comment thread diffpy/pdfmorph/morphs/morph.py
@@ -24,7 +24,7 @@
class MorphXtalPDFtoRDF(Morph):

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 is not a "morph" this is simply a transformation. Please can we change this language? I want to merge this so please make an issue to change the language (and name) on this.

Having said that, leave all the changes you have done and I will merge it, but let's think a bit about the class name and the docstring/documentation. I should probably understand exactly what is being done here before we finalize this, but stick it on an issue (and add it to the release milestone) so we loop back to it

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Yep, I'll open a new issue for this (and below)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I am having trouble adding the issue to the milestone

@@ -24,7 +24,7 @@
class MorphXtalRDFtoPDF(Morph):

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 above

Comment thread diffpy/pdfmorph/pdfmorphapp.py
Comment on lines +181 to +198
group.add_option(
'--usefilenames',
action="store_true",
dest="usefilenames",
help="Use the file names as labels on plot."
)
group.add_option(
'--mlabel',
metavar="MLABEL",
dest="mlabel",
help="Set label for morphed data to MLABEL on plot. Ignored if using file names as labels.",
)
group.add_option(
'--tlabel',
metavar="TLABEL",
dest="tlabel",
help="Set label for target data to TLABEL on plot. Ignored if using file names as labels.",
)

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.

looks good, see comment. Please put different issues on different PRs

@Sparks29032

Sparks29032 commented Jun 18, 2023

Copy link
Copy Markdown
Collaborator Author

Please see quick inline comments and I can merge.

Please put less on each PR to make it easier to review and merge. One thing per branch/pr ideally. If something is a quick cleaning thing you can add it to another one, but this should have been at least two PRs if not three.

Looked over inline comments; I will put less in each PR in the future, sorry for bundling them all together this time

@sbillinge sbillinge merged commit 773e6f4 into diffpy:main Jun 18, 2023
@Sparks29032 Sparks29032 deleted the rework_documentation branch May 30, 2024 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants