Skip to content

docs: polish throughout#895

Merged
samsja merged 11 commits intomainfrom
docs-polish
Dec 12, 2022
Merged

docs: polish throughout#895
samsja merged 11 commits intomainfrom
docs-polish

Conversation

@alexcg1
Copy link
Copy Markdown
Contributor

@alexcg1 alexcg1 commented Dec 6, 2022

  • docs(datatypes/text): fix wording

Goals:

  • check and update documentation, if required. See guide

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Dec 6, 2022 •
edited
Loading

Codecov Report

Base: 88.06% // Head: 84.57% // Decreases project coverage by -3.49% ⚠️

Coverage data is based on head (13e9e75) compared to base (d9e5b26).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #895      +/-   ##
==========================================
- Coverage   88.06%   84.57%   -3.50%     
==========================================
  Files         138      149      +11     
  Lines        7154     7674     +520     
==========================================
+ Hits         6300     6490     +190     
- Misses        854     1184     +330
Flag Coverage Δ
docarray 84.57% <ø> (-3.50%) ⬇️

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

Impacted Files Coverage Δ
docarray/array/mixins/embed.py 9.89% <0.00%> (-82.42%) ⬇️
docarray/array/mixins/evaluation.py 8.33% <0.00%> (-80.13%) ⬇️
docarray/array/storage/memory/find.py 54.68% <0.00%> (-40.63%) ⬇️
docarray/document/mixins/sugar.py 60.00% <0.00%> (-20.00%) ⬇️
docarray/array/mixins/group.py 71.05% <0.00%> (-18.43%) ⬇️
docarray/math/helper.py 67.64% <0.00%> (-17.65%) ⬇️
docarray/array/mixins/match.py 83.33% <0.00%> (-8.34%) ⬇️
docarray/array/mixins/setitem.py 74.79% <0.00%> (-8.14%) ⬇️
docarray/score/data.py 95.45% <0.00%> (-4.55%) ⬇️
docarray/array/mixins/find.py 89.21% <0.00%> (-1.97%) ⬇️
... and 13 more

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

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@alexcg1
Copy link
Copy Markdown
Contributor Author

alexcg1 commented Dec 6, 2022

Don't merge this til after v0.20 goes out. Let's get that out the door first

@github-actions github-actions bot added size/m and removed size/s labels Dec 6, 2022
@alexcg1 alexcg1 marked this pull request as draft December 7, 2022 08:53
@alexcg1 alexcg1 removed the request for review from JohannesMessner December 7, 2022 13:16
@alexcg1 alexcg1 changed the title docs: improve wording for datatypes and textual index page docs: polish throughout Dec 8, 2022
@github-actions github-actions bot added size/xl and removed size/m labels Dec 9, 2022
@github-actions
Copy link
Copy Markdown

github-actions bot commented Dec 9, 2022

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

@alexcg1
Merge branch 'main' into docs-polish
13e9e75 
Signed-off-by: Alex Cureton-Griffiths <[email protected]>
@github-actions
Copy link
Copy Markdown

github-actions bot commented Dec 9, 2022

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Dec 9, 2022

📝 Docs are deployed on https://ft-docs-polish--jina-docs.netlify.app 🎉

@alexcg1 alexcg1 requested a review from samsja December 9, 2022 09:15
@alexcg1 alexcg1 marked this pull request as ready for review December 9, 2022 09:15
@samsja samsja merged commit 59606d8 into main Dec 12, 2022
@samsja samsja deleted the docs-polish branch December 12, 2022 08:09
@alexcg1 alexcg1 mentioned this pull request Dec 12, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JohannesMessner JohannesMessner JohannesMessner approved these changes

@samsja samsja samsja approved these changes

Assignees

No one assigned

Labels

area/docs size/xl

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@alexcg1 @codecov-commenter @JohannesMessner @samsja