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

[Docs] Update tuple output examples in flytesnacks/flytekit docs #1710

Closed
2 tasks done
cosmicBboy opened this issue Oct 19, 2021 · 9 comments
Closed
2 tasks done

[Docs] Update tuple output examples in flytesnacks/flytekit docs #1710

cosmicBboy opened this issue Oct 19, 2021 · 9 comments
Assignees
Labels
documentation Improvements or additions to documentation hacktoberfest untriaged This issues has not yet been looked at by the Maintainers

Comments

@cosmicBboy
Copy link
Contributor

Description

currently our docs have output function sigs for tuples as

def func() -> (int, str):

We added support for the correct syntax:

def func() -> Tuple[int,str]:

The purpose of this issue is to update all instances of the former to the latter

Are you sure this issue hasn't been raised already?

  • Yes

Have you read the Code of Conduct?

  • Yes
@cosmicBboy cosmicBboy added documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers labels Oct 19, 2021
@Qiwen-Yu
Copy link

@cosmicBboy Can I take this one?

@cosmicBboy
Copy link
Contributor Author

@Qiwen-Yu yes! let me assign you. Also let me know if you need any help setting your repo up. Examples in both flytekit and flytesnacks probably need to be updated.

@Qiwen-Yu
Copy link

Correct me if I were wrong, the scope is to fix all tuple type hints to Tuple[] for files in https://github.com/flyteorg/flyte/tree/master/rsts, https://github.com/flyteorg/flytekit/tree/master/docs and https://github.com/flyteorg/flytesnacks/tree/master/cookbook, am I right?

@cosmicBboy
Copy link
Contributor Author

yep, that's correct!

@Qiwen-Yu
Copy link

@cosmicBboy Hi, I'm still working on this.

@cosmicBboy
Copy link
Contributor Author

cosmicBboy commented Oct 26, 2021

cool! don't hesitate to reach out if you need anything

Qiwen-Yu added a commit to Qiwen-Yu/flytekit that referenced this issue Oct 28, 2021
fix issue flyteorg#1710, flyteorg/flyte#1710
update typing hints for tuple
Qiwen-Yu added a commit to Qiwen-Yu/flytesnacks that referenced this issue Oct 28, 2021
fix issue #1710
flyteorg/flyte#1710
change typing hints from ( , ) to Tuple[ , ]
@Qiwen-Yu
Copy link

@cosmicBboy Hi, I've made several changes.

Qiwen-Yu added a commit to Qiwen-Yu/flytesnacks that referenced this issue Oct 29, 2021
fix issue #1710
flyteorg/flyte#1710
change typing hints from ( , ) to Tuple[ , ]

Signed-off-by: Qiwen Yu <yvaineyuu.0201@gmail.com>
Qiwen-Yu added a commit to Qiwen-Yu/flytekit that referenced this issue Oct 29, 2021
fix issue flyteorg#1710, flyteorg/flyte#1710
update typing hints for tuple

Signed-off-by: Qiwen Yu <yvaineyuu.0201@gmail.com>
Qiwen-Yu added a commit to Qiwen-Yu/flytesnacks that referenced this issue Oct 29, 2021
fix issue #1710
flyteorg/flyte#1710
change typing hints from ( , ) to Tuple[ , ]

Signed-off-by: Qiwen Yu <yvaineyuu.0201@gmail.com>
samhita-alla pushed a commit to flyteorg/flytesnacks that referenced this issue Oct 31, 2021
* update task cache docs (#459)

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
Signed-off-by: Qiwen Yu <yvaineyuu.0201@gmail.com>

* update typing for Tuple

fix issue #1710
flyteorg/flyte#1710
change typing hints from ( , ) to Tuple[ , ]

Signed-off-by: Qiwen Yu <yvaineyuu.0201@gmail.com>

* update more Tuple typing hints

Signed-off-by: Qiwen Yu <yvaineyuu.0201@gmail.com>

Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>
@samhita-alla
Copy link
Contributor

@Qiwen-Yu, can you fill in this form?

@Qiwen-Yu
Copy link

@Qiwen-Yu, can you fill in this form?

Hi, I have filled in this form. Thanks a lot!

pingsutw pushed a commit to pingsutw/flyte-monorepo that referenced this issue Apr 4, 2023
* update task cache docs (#459)

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
Signed-off-by: Qiwen Yu <yvaineyuu.0201@gmail.com>

* update typing for Tuple

fix issue #1710
flyteorg/flyte#1710
change typing hints from ( , ) to Tuple[ , ]

Signed-off-by: Qiwen Yu <yvaineyuu.0201@gmail.com>

* update more Tuple typing hints

Signed-off-by: Qiwen Yu <yvaineyuu.0201@gmail.com>

Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest untriaged This issues has not yet been looked at by the Maintainers
Projects
None yet
Development

No branches or pull requests

3 participants