Skip to content

docs: polish throughout#895

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

docs: polish throughout#895
samsja merged 11 commits into
mainfrom
docs-polish

Conversation

@alexcg1

@alexcg1 alexcg1 commented Dec 6, 2022

Copy link
Copy Markdown
Contributor
  • docs(datatypes/text): fix wording

Goals:

  • check and update documentation, if required. See guide

@alexcg1
docs(datatypes/text): fix wording
2dac540 
Signed-off-by: Alex C-G <alexcg@outlook.com>
@codecov-commenter

codecov-commenter commented Dec 6, 2022 •
edited by codecov Bot
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.11%. Comparing base (d9e5b26) to head (13e9e75).
⚠️ Report is 592 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #895      +/-   ##
==========================================
+ Coverage   88.06%   88.11%   +0.05%     
==========================================
  Files         138      149      +11     
  Lines        7154     7674     +520     
==========================================
+ Hits         6300     6762     +462     
- Misses        854      912      +58
Flag Coverage Δ
docarray 88.11% <ø> (+0.05%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@alexcg1

alexcg1 commented Dec 6, 2022

Copy link
Copy Markdown
Contributor Author

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

@alexcg1
docs(dataclass): polish wording
d3421e5 
Signed-off-by: Alex C-G <alexcg@outlook.com>
@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
docs(dataclass): polish wording
a210fea 
Signed-off-by: Alex C-G <alexcg@outlook.com>
@alexcg1 alexcg1 removed the request for review from JohannesMessner December 7, 2022 13:16
@alexcg1
docs(document store): polish wording
e158407 
Signed-off-by: Alex C-G <alexcg@outlook.com>
@alexcg1
docs(document): polish wording
6952f88 
Signed-off-by: Alex C-G <alexcg@outlook.com>
@alexcg1 alexcg1 changed the title docs: improve wording for datatypes and textual index page docs: polish throughout Dec 8, 2022
@alexcg1
docs(documentarray): polish wording
e7c4153 
Signed-off-by: Alex C-G <alexcg@outlook.com>
@alexcg1
docs: us english spelling of neighbor
256b556 
Signed-off-by: Alex C-G <alexcg@outlook.com>
@alexcg1
docs: consistent use of _you_ can, not _one_ can
d718c56 
Signed-off-by: Alex C-G <alexcg@outlook.com>
@alexcg1
docs: consistent use of present simple tense and a few other fixes
74141b7 
Signed-off-by: Alex C-G <alexcg@outlook.com>
@github-actions github-actions Bot added size/xl and removed size/m labels Dec 9, 2022
@github-actions

github-actions Bot commented Dec 9, 2022

Copy link
Copy Markdown

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
docs: change instances of _we_ to _you_
8653ddd 
Signed-off-by: Alex C-G <alexcg@outlook.com>
@alexcg1
Merge branch 'main' into docs-polish
13e9e75 
Signed-off-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
@github-actions

github-actions Bot commented Dec 9, 2022

Copy link
Copy Markdown

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

github-actions Bot commented Dec 9, 2022

Copy link
Copy Markdown

📝 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