docs cookbook polish #2446
docs cookbook polish #2446
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2446 +/- ##
==========================================
- Coverage 83.56% 83.44% -0.12%
==========================================
Files 150 150
Lines 9380 9380
==========================================
- Hits 7838 7827 -11
- Misses 1542 1553 +11
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
| @@ -1,7 +1,7 @@ | |||
| # Cookbook on Clean Code | |||
There was a problem hiding this comment.
Shouldn't we follow the same guidelines as for other READMES? So title case here too?
There was a problem hiding this comment.
Title case doesn't mean every word capitalized :) This is in title case already
.github/2.0/cookbooks/Document.md
Outdated
| @@ -574,12 +574,12 @@ DocumentArray has 3 items: | |||
|
|
|||
| ### Use `itertools` on `DocumentArray` | |||
|
|
|||
| As `DocumenArray` is an `Iterable`, you can also use [Python built-in `itertools` module](https://docs.python.org/3/library/itertools.html) on it. This enables advanced "iterator algebra" on the `DocumentArray`. | |||
| As `DocumentArray` is an `Iterable`. You can also use [Python's built-in `itertools` module](https://docs.python.org/3/library/itertools.html) on it. This enables advanced "iterator algebra" on the `DocumentArray`. | |||
There was a problem hiding this comment.
We really should have a dot here? those two sentences are connected right?
Fixed |
|
@hanxiao @theUnkownName please let me know if you find any other glitches. Git was throwing merge conflict stuff at me earlier - I'm pretty sure all of my edits and corrections got through (and I checked), but something might've fallen through the gaps |
Is it me maybe? I'm not seeing any of the changes |
|
For some reason we can't see any of the changes on the GitHub interface. But if you go to the branch in the repo you can see the updated docs (either here or in your terminal) |
.github/2.0/cookbooks/Document.md
Outdated
| <jina.types.Document.Document id=2ca74b98-aed9-11eb-b791-1e008a366d48 mimeType=text/plain text=hello at 6247702096> | ||
| <jina.types.Document.Document id=2ca74f1c-aed9-11eb-b791-1e008a366d48 buffer=DDE= mimeType=text/plain at 6247702160> | ||
| <jina.types.Document.Document id=2caab594-aed9-11eb-b791-1e008a366d48 blob={'dense': {'buffer': 'AQAAAAAAAAACAAAAAAAAAAMAAAAAAAAA', 'shape': [3], 'dtype': '<i8'}} at 6247702416> | ||
| <jina.types.Document.Document id=4c008c40-af9f-11eb-bb84-1e008a366d49 uri=https://static.jina.ai/logo/core/notext/light/logo.png mimeType=image/png at 6252395600> |
There was a problem hiding this comment.
| <jina.types.Document.Document id=2ca74b98-aed9-11eb-b791-1e008a366d48 mimeType=text/plain text=hello at 6247702096> | |
| <jina.types.Document.Document id=2ca74f1c-aed9-11eb-b791-1e008a366d48 buffer=DDE= mimeType=text/plain at 6247702160> | |
| <jina.types.Document.Document id=2caab594-aed9-11eb-b791-1e008a366d48 blob={'dense': {'buffer': 'AQAAAAAAAAACAAAAAAAAAAMAAAAAAAAA', 'shape': [3], 'dtype': '<i8'}} at 6247702416> | |
| <jina.types.Document.Document id=4c008c40-af9f-11eb-bb84-1e008a366d49 uri=https://static.jina.ai/logo/core/notext/light/logo.png mimeType=image/png at 6252395600> | |
| <jina.types.document.Document id=2ca74b98-aed9-11eb-b791-1e008a366d48 mimeType=text/plain text=hello at 6247702096> | |
| <jina.types.document.Document id=2ca74f1c-aed9-11eb-b791-1e008a366d48 buffer=DDE= mimeType=text/plain at 6247702160> | |
| <jina.types.document.Document id=2caab594-aed9-11eb-b791-1e008a366d48 blob={'dense': {'buffer': 'AQAAAAAAAAACAAAAAAAAAAMAAAAAAAAA', 'shape': [3], 'dtype': '<i8'}} at 6247702416> | |
| <jina.types.document.Document id=4c008c40-af9f-11eb-bb84-1e008a366d49 uri=https://static.jina.ai/logo/core/notext/light/logo.png mimeType=image/png at 6252395600> |
There was a problem hiding this comment.
same for all incode document, they have to be lower case, because they implies a real module path
There was a problem hiding this comment.
I changed those all already. For some reason my commit isn't showing in the PR, but it's showing in the branch itself. God knows how or why
There was a problem hiding this comment.
WTF? I'm going to look into this. I DEFINITELY changed all of those yesterday. I remember going through it by hand. And now it's not showing on my local box
There was a problem hiding this comment.
OK, fixed. And I ran a grep on all the files to ensure there are no remaining occurrences
Just some minor wording cleanup. Re-reading and editing also helps it live in my brain