[DOC]: Improve documentation #220

2023-04-10T22:14:46Z

synchon commented

2023-04-10 22:14:46 +00:00

(Migrated from github.com)

description of feature/fix
add an entry for the latest changes

This PR sets line length for .rst files to 80, improves general prose and formatting along with code block updates for docs. Also, runs black=23.x.x for the codebase.

* [x] description of feature/fix * [x] add an entry for the latest changes This PR sets line length for `.rst` files to `80`, improves general prose and formatting along with code block updates for docs. Also, runs `black=23.x.x` for the codebase.

codecov[bot] commented

2023-04-10 22:15:40 +00:00

(Migrated from github.com)

Codecov Report

Merging #220 (24a0ec6) into main (aeb03c7) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #220   +/-   ##
=======================================
  Coverage   93.60%   93.60%           
=======================================
  Files          80       80           
  Lines        3458     3458           
  Branches      653      653           
=======================================
  Hits         3237     3237           
  Misses        144      144           
  Partials       77       77

Flag	Coverage Δ
docs	`100.00% <ø> (ø)`
junifer	`93.60% <ø> (ø)`

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

## [Codecov](https://codecov.io/gh/juaml/junifer/pull/220?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) Report > Merging [#220](https://codecov.io/gh/juaml/junifer/pull/220?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (24a0ec6) into [main](https://codecov.io/gh/juaml/junifer/commit/aeb03c720be65cc76f35d71b10b20f7f2be71425?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (aeb03c7) will **not change** coverage. > The diff coverage is `n/a`. [![Impacted file tree graph](https://codecov.io/gh/juaml/junifer/pull/220/graphs/tree.svg?width=650&height=150&src=pr&token=5H21JuZXMw&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml)](https://codecov.io/gh/juaml/junifer/pull/220?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) ```diff @@ Coverage Diff @@ ## main #220 +/- ## ======================================= Coverage 93.60% 93.60% ======================================= Files 80 80 Lines 3458 3458 Branches 653 653 ======================================= Hits 3237 3237 Misses 144 144 Partials 77 77 ``` | Flag | Coverage Δ | | |---|---|---| | docs | `100.00% <ø> (ø)` | | | junifer | `93.60% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#carryforward-flags-in-the-pull-request-comment) to find out more.

github-actions[bot] commented

2023-04-10 22:20:33 +00:00

(Migrated from github.com)

PR Preview Action v0.0.2-36-g34035faf
Preview removed because the pull request was closed.
2023-04-17 11:57 UTC

[PR Preview Action](https://github.com/rossjrw/pr-preview-action) v0.0.2-36-g34035faf :---: Preview removed because the pull request was closed. 2023-04-17 11:57 UTC

fraimondo (Migrated from github.com) requested changes

2023-04-17 08:50:12 +00:00

docs/extending/datagrabber.rst

					
				@ -272,29 +272,31 @@ And we can create our datagrabber:

				Option B: Extending from BaseDataGrabber

same, see above

I removed the typing from the examples on purpose.

While it's better for the actual code, it just makes the example more complicated to read with this kind of things.

I removed the typing from the examples on purpose. While it's better for the actual code, it just makes the example more complicated to read with this kind of things.

docs/extending/datagrabber.rst

Don't do this. Keep the example simple.

synchon (Migrated from github.com) reviewed

2023-04-17 09:24:10 +00:00

docs/extending/datagrabber.rst

					
				@ -272,29 +272,31 @@ And we can create our datagrabber:

				Option B: Extending from BaseDataGrabber

I'll simplify it.

fraimondo (Migrated from github.com) approved these changes

2023-04-17 11:49:46 +00:00

Sign in to join this conversation.

No reviewers

fraimondo

No labels

No milestone

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

juaml/junifer!220

				`@ -272,29 +272,31 @@ And we can create our datagrabber:`
				`Option B: Extending from BaseDataGrabber`

Rows
Columns