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

Documentation cleanup #3720

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Conversation

astro-friedel
Copy link

@astro-friedel astro-friedel commented Dec 10, 2024

Description

This PR is just a cleanup of the documentation. It was motivated by a recent PR where many small changes were made to the documentation files that were not really part of the PR (specifically trailing white spaces were automatically removed b y the IDE).

Specific changes that were made:

  • remove all trailing white spaces
  • wrap all lines at column 100 (seemed to be the most common word wrapping already in use), some lines still go beyond this limit due to long links, python code, and puncutuation
  • added docs/stubs and docs/1-parsl-introduction.ipynb to .gitignore since they are generated
  • minor spelling and grammer fixes

Changed Behaviour

There should be no outward changes introduced by this PR, just re-formatting of the documentation source files.

Fixes

Fixes # (issue)

Type of change

Choose which options apply, and delete the ones which do not apply.

  • Update to human readable text: Documentation/error messages/comments
  • Code maintenance/cleanup

have not been updated since then. For that reason, this section is marked
as historical.
This scalability review summarises results in a paper, Parsl: Pervasive Parallel Programming in
Python, which was published in 2019. The results have not been updated since then. For that reason,
Copy link
Collaborator

Choose a reason for hiding this comment

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

 Warning, treated as error:
/home/runner/work/parsl/parsl/docs/historical/performance.rst:8:Block quote ends without a blank line; unexpected unindent.

I think this line and the subsequent one should all be indented to the same depth as line 7

have not been updated since then. For that reason, this section is marked
as historical.
This scalability review summarises results in a paper, Parsl: Pervasive Parallel Programming in
Python, which was published in 2019. The results have not been updated since then. For that reason,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Python, which was published in 2019. The results have not been updated since then. For that reason,
Python, which was published in 2019. The results have not been updated since then. For that reason,

as historical.
This scalability review summarises results in a paper, Parsl: Pervasive Parallel Programming in
Python, which was published in 2019. The results have not been updated since then. For that reason,
this section is marked as historical.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
this section is marked as historical.
this section is marked as historical.

Sign up for free to 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.

2 participants