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

include a description of WORKFLOW_SHARE_DIR/bin and lib/python #609

Merged
merged 13 commits into from
Jun 6, 2023

Conversation

wxtim
Copy link
Member

@wxtim wxtim commented May 9, 2023

Accompanies changes to cylc/cylc-flow#5525

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.

@wxtim wxtim requested review from hjoliver and MetRonnie May 9, 2023 14:19
@wxtim wxtim self-assigned this May 9, 2023
@wxtim wxtim added this to the 8.2.0 milestone May 9, 2023
@wxtim wxtim force-pushed the feature.support_share/bin_and_share/lib branch from add9c45 to 3543dee Compare May 9, 2023 15:05
Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

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

One small tweak suggested.

src/user-guide/writing-workflows/configuration.rst Outdated Show resolved Hide resolved
Co-authored-by: Hilary James Oliver <hilary.j.oliver@gmail.com>
@hjoliver hjoliver self-requested a review May 12, 2023 01:41
src/user-guide/writing-workflows/runtime.rst Outdated Show resolved Hide resolved
src/user-guide/writing-workflows/runtime.rst Outdated Show resolved Hide resolved
wxtim and others added 2 commits May 12, 2023 08:57
Co-authored-by: Hilary James Oliver <hilary.j.oliver@gmail.com>
Co-authored-by: Hilary James Oliver <hilary.j.oliver@gmail.com>
@wxtim wxtim requested a review from hjoliver May 12, 2023 07:58
src/user-guide/installing-workflows.rst Outdated Show resolved Hide resolved
src/user-guide/writing-workflows/runtime.rst Outdated Show resolved Hide resolved
Comment on lines 338 to 339
These locations will be placed first in the executable and Python module
search paths, before those in the parent run directory .
Copy link
Member

Choose a reason for hiding this comment

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

Maybe

Suggested change
These locations will be placed first in the executable and Python module
search paths, before those in the parent run directory .
These locations take precedence over the top level ``bin/`` and
``lib/python/`` directories in the run dir.

Copy link
Member

@hjoliver hjoliver May 23, 2023

Choose a reason for hiding this comment

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

@wxtim and @MetRonnie - this kind of reverses my 2nd review suggestion above. I would prefer to just "state the facts" here, which is where these directories are put in the search paths. "Take precedence" or "called first" (Tim's original phrasing) could be assumed to have wider implications, e.g. for how Cylc itself somehow uses these locations.

Copy link
Member Author

Choose a reason for hiding this comment

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

I rather agree with Hilary - can we come to a conclusion @MetRonnie ?

Copy link
Member

Choose a reason for hiding this comment

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

wxtim and others added 3 commits May 22, 2023 16:17
Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
@wxtim wxtim requested a review from MetRonnie May 22, 2023 15:19
@wxtim wxtim requested a review from MetRonnie May 23, 2023 09:46
Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
@wxtim wxtim requested a review from MetRonnie June 5, 2023 10:22
Copy link
Member

@MetRonnie MetRonnie left a comment

Choose a reason for hiding this comment

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

Still got a build failure

wxtim added 2 commits June 6, 2023 13:29
…wxtim/cylc-doc into feature.support_share/bin_and_share/lib

* 'feature.support_share/bin_and_share/lib' of github.com:wxtim/cylc-doc:
  Update src/user-guide/writing-workflows/runtime.rst
  Update src/user-guide/installing-workflows.rst
  Apply suggestions from code review
  Update src/user-guide/writing-workflows/runtime.rst
  Update src/user-guide/writing-workflows/runtime.rst
  Update src/user-guide/writing-workflows/runtime.rst
  Apply suggestions from code review
  add some extra links
  Update src/user-guide/writing-workflows/configuration.rst
@wxtim wxtim merged commit 801bf49 into cylc:master Jun 6, 2023
@wxtim wxtim deleted the feature.support_share/bin_and_share/lib branch September 27, 2023 11:37
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.

3 participants