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.

Sign up for GitHub

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

Jump to bottom

Add description template snippet for copy-pasting #301

Merged
merged 7 commits into from
Oct 6, 2023
Merged

Add description template snippet for copy-pasting #301

merged 7 commits into from
Oct 6, 2023

Conversation

adswa
Copy link
Member

@adswa adswa commented Oct 5, 2023

fixes #300

@adswa adswa requested a review from mslw October 5, 2023 11:36
adswa
adswa commented Oct 5, 2023
View reviewed changes
docs/source/settingup.rst Outdated Show resolved Hide resolved
@adswa
Copy link
Member Author

adswa commented Oct 5, 2023

well, it is ugly on Jülich data - there are no linebreaks....
image

Any ideas how this could become more legible?

@adswa
Copy link
Member Author

adswa commented Oct 5, 2023

(the right) HTML tags make things nicer:

image

mslw
mslw approved these changes Oct 5, 2023
View reviewed changes
Copy link
Contributor

@mslw mslw left a comment

Choose a reason for hiding this comment

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

I think it is a very fitting description template, and I agree that it would be good to provide it in the docs. Minor suggestions, up for your decision, left in text.

docs/source/settingup.rst Outdated Show resolved Hide resolved
docs/source/settingup.rst Outdated Show resolved Hide resolved
mslw
mslw requested changes Oct 5, 2023
View reviewed changes
Copy link
Contributor

@mslw mslw left a comment

Choose a reason for hiding this comment

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

Ah, one important change is that one URL didn't work for me.

docs/source/settingup.rst Show resolved Hide resolved
adswa and others added 2 commits October 6, 2023 08:43
@adswa @mslw
remove markup for consistency
cce8c9c 
Co-authored-by: Michał Szczepanik <m.szczepanik@fz-juelich.de>
@adswa @mslw
improve wording about file retrieval
c9b9c50 
Co-authored-by: Michał Szczepanik <m.szczepanik@fz-juelich.de>
@adswa adswa requested a review from mslw October 6, 2023 08:43
mslw
mslw approved these changes Oct 6, 2023
View reviewed changes
Copy link
Contributor

@mslw mslw left a comment

Choose a reason for hiding this comment

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

Great, thx!

@mslw mslw merged commit fbc0e0e into main Oct 6, 2023
@mslw mslw deleted the doc-300 branch October 6, 2023 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mslw mslw mslw approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

DOC: Add a description template for copy-pasting
2 participants
@adswa @mslw