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

Eliminate old tutorial from SasView 5x #1949

Merged
merged 3 commits into from Nov 6, 2021
Merged

Eliminate old tutorial from SasView 5x #1949

merged 3 commits into from Nov 6, 2021

Conversation

smk78
Copy link
Contributor

@smk78 smk78 commented Nov 3, 2021

This PR completely removes the old v2 tutorial (that had been kept through v3x and 4x) from the SasView repo.

The old tutorial (in all its guises) has, however, been preserved in the tutorials repo through the separate commit SasView/tutorials@c0e852a

A copy of subtracting_a_model_calculation_from_real_data_v4x.pdf has been added as subtracting_a_model_calculation_from_real_data_v5x.pdf.

tutorials.rst has been updated as required.

@smk78 smk78 added the Documentation Concerns documentation label Nov 3, 2021
@smk78 smk78 added this to the SasView 5.0.5 milestone Nov 3, 2021
@smk78 smk78 self-assigned this Nov 3, 2021
@smk78 smk78 added this to To do in SasViewHackathon-IV Nov 3, 2021
@smk78 smk78 moved this from To do to Under Review in SasViewHackathon-IV Nov 3, 2021
Copy link
Member

@butlerpd butlerpd left a comment

Choose a reason for hiding this comment

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

I have not yet tested the changes but the coding changes look fine save one point:

Opening the file renamed from v4 to v5 seems it seems to actually be a version 4 tutorial. Nothing has really changed I don't think in the add/subtract data but all the GUI images are clearly 4.x images. All other files seem to be of the 5.x GUI.

Not sure the best way to address, other than the nomenclature of the file should probably stay at 4.x. Perhaps that is all that is needed since nothing but the "look" changed. There is no label for the user to see saying the graphics are from any particular version. Alternatively I suppose we could add a parenthentical comment on that particular line saying GUI images are from 4.x but that the tutorial is otherwise uptodate?

@butlerpd butlerpd moved this from Under Review to Under Revision in SasViewHackathon-IV Nov 3, 2021
@smk78
Copy link
Contributor Author

smk78 commented Nov 3, 2021

Replying to @butlerpd:

Yes, well spotted. It was on my to-do list (really)! :-) Have just pushed a revised version of that tutorial updated to v5 Win.

@smk78 smk78 moved this from Under Revision to Under Review in SasViewHackathon-IV Nov 3, 2021
@butlerpd butlerpd moved this from Under Review to Under Revision in SasViewHackathon-IV Nov 3, 2021
@smk78 smk78 moved this from Under Revision to Under Review in SasViewHackathon-IV Nov 4, 2021
@butlerpd
Copy link
Member

butlerpd commented Nov 4, 2021

I am confused @smk78 this was moved back to under review but nothing has changed? Do the link still does not work. Did I miss something?

@smk78
Copy link
Contributor Author

smk78 commented Nov 5, 2021

@Butler: So if you look at the workflow history, you pointed out the file needed revising and moved this PR from Review to Revision. I committed an updated file and moved the PR back to Review. But for unspecified reasons you moved it back to Revision so I moved it back to Review! If you look at src/sas/sasview/media/subtracting_a_model_calculation_from_real_data_v5.pdf you will see this is now updated to v5.

@smk78
Copy link
Contributor Author

smk78 commented Nov 5, 2021

Ahh. But I did forget to update tutorial.rst I see...

Copy link
Member

@butlerpd butlerpd left a comment

Choose a reason for hiding this comment

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

Nice job on the new tutorial... I realize it was probably just an image replacement but there were quite a few. Anyway all seems well now.

docs/sphinx-docs/source/user/tutorial.rst Outdated Show resolved Hide resolved
SasViewHackathon-IV automation moved this from Under Review to Ready to merge Nov 6, 2021
@butlerpd butlerpd merged commit 2c59751 into main Nov 6, 2021
SasViewHackathon-IV automation moved this from Ready to merge to Done Nov 6, 2021
@butlerpd butlerpd deleted the TutorialsUpdate branch November 6, 2021 00:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Concerns documentation
Projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants