Improve clarity in code and docs #1052
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: David Mertz <[email protected]>
ppiegaze
previously approved these changes
Jul 25, 2023
| @@ -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. | |||
There was a problem hiding this comment.
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. | |||
There was a problem hiding this comment.
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. |
cosmicBboy
reviewed
Jul 25, 2023
Co-authored-by: Niels Bantilan <[email protected]> Signed-off-by: David Q Mertz <[email protected]>
cosmicBboy
approved these changes
Jul 25, 2023
|
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Only copy-edit style changes.
Attn: @ppiegaze