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

Improve clarity in code and docs #1052

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

Conversation

DavidMertz
Copy link
Contributor

@DavidMertz DavidMertz commented Jul 24, 2023

Only copy-edit style changes.

Attn: @ppiegaze

ppiegaze
ppiegaze previously approved these changes Jul 25, 2023
Copy link
Member

@ppiegaze ppiegaze left a comment

Choose a reason for hiding this comment

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

LGTM! A couple minor changes added.

@@ -269,7 +269,7 @@ By default, the `docker_build.sh` script:
- Uses the `PROJECT_NAME` specified in the `pyflyte init` command, which in
this case is `my_project`.
- Will not use any remote registry.
- Uses the git sha to version your tasks and workflows.
- Uses the git revision SHA1 to version your tasks and workflows.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Uses the git revision SHA1 to version your tasks and workflows.
- Uses the git revision ID (the SHA hash) to version your tasks and workflows.

@@ -367,7 +367,7 @@ Let's break down what each flag is doing here:
- `--archive`: This argument allows you to pass in a package file, which in
this case is `flyte-package.tgz`.
- `--version`: This is a version string that can be any string, but we recommend
using the git sha in general, especially in production use cases.
using the git revision in general, especially in production use cases.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
using the git revision in general, especially in production use cases.
using the git revision ID (the SHA hash), especially in production use cases.

Co-authored-by: Niels Bantilan <[email protected]>
Signed-off-by: David Q Mertz <[email protected]>
@cosmicBboy
Copy link
Contributor

looks like there are some linting issues.

Will need to run pre-commit hooks to address those: https://docs.flyte.org/projects/cookbook/en/latest/contribute.html#pre-commit-hooks

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