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: common args inheritence from Flow API #5535

Merged
merged 7 commits into from Dec 19, 2022
Merged

docs: common args inheritence from Flow API #5535

merged 7 commits into from Dec 19, 2022

Conversation

AnneYang720
Copy link
Contributor

Goals:

@AnneYang720 AnneYang720 marked this pull request as draft December 16, 2022 15:10
@github-actions github-actions bot added size/XS area/docs This issue/PR affects the docs labels Dec 16, 2022
Copy link
Contributor

@alaeddine-13 alaeddine-13 left a comment

Choose a reason for hiding this comment

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

I think the changes should be in create section https://docs.jina.ai/concepts/flow/basics/#create

@alaeddine-13
Copy link
Contributor

Also update the docstring of flow constructor (we want to see such information in the flow constructor API)
https://docs.jina.ai/api/jina.orchestrate.flow.base/#jina.orchestrate.flow.base.Flow

@github-actions github-actions bot added size/S area/core This issue/PR affects the core codebase labels Dec 16, 2022
@codecov
Copy link

codecov bot commented Dec 16, 2022

Codecov Report

Merging #5535 (77fe586) into master (3c09e6e) will decrease coverage by 2.57%.
The diff coverage is n/a.

❗ Current head 77fe586 differs from pull request most recent head fede1c6. Consider uploading reports for the commit fede1c6 to get more accurate results

@@            Coverage Diff             @@
##           master    #5535      +/-   ##
==========================================
- Coverage   86.79%   84.21%   -2.58%     
==========================================
  Files         122      122              
  Lines        9815     9815              
==========================================
- Hits         8519     8266     -253     
- Misses       1296     1549     +253     
Flag Coverage Δ
jina 84.21% <ø> (-2.58%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
jina/orchestrate/flow/base.py 84.15% <ø> (-6.01%) ⬇️
jina/serve/runtimes/gateway/composite/gateway.py 33.33% <0.00%> (-66.67%) ⬇️
...a/orchestrate/deployments/config/docker_compose.py 63.28% <0.00%> (-35.75%) ⬇️
jina/orchestrate/deployments/config/k8s.py 66.87% <0.00%> (-33.13%) ⬇️
...rate/deployments/config/k8slib/kubernetes_tools.py 78.57% <0.00%> (-21.43%) ⬇️
jina/jaml/parsers/__init__.py 81.81% <0.00%> (-15.91%) ⬇️
jina/orchestrate/deployments/__init__.py 77.75% <0.00%> (-12.87%) ⬇️
jina/orchestrate/deployments/config/helper.py 78.18% <0.00%> (-12.73%) ⬇️
...deployments/config/k8slib/kubernetes_deployment.py 54.41% <0.00%> (-10.30%) ⬇️
... and 21 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

docs/concepts/flow/basics.md Outdated Show resolved Hide resolved
jina/orchestrate/flow/base.py Outdated Show resolved Hide resolved
jina/orchestrate/flow/base.py Outdated Show resolved Hide resolved
@AnneYang720 AnneYang720 marked this pull request as ready for review December 19, 2022 08:25
@alexcg1
Copy link
Member

alexcg1 commented Dec 19, 2022

@scott-martens if you have time today could you handle this?

@scott-martens
Copy link
Member

Documentation change looks good to me.

docs/concepts/flow/basics.md Outdated Show resolved Hide resolved
jina/orchestrate/flow/base.py Outdated Show resolved Hide resolved
@github-actions
Copy link

📝 Docs are deployed on https://doc-flow-args--jina-docs.netlify.app 🎉

@JoanFM JoanFM merged commit 27acb88 into master Dec 19, 2022
@JoanFM JoanFM deleted the doc-flow-args branch December 19, 2022 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/core This issue/PR affects the core codebase area/docs This issue/PR affects the docs size/S size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the common args inheritence from Flow API to Executors and Gateway
5 participants