[DOC]: Change `init.py` docstrings to reflect sub-packages #115

Merged

synchon merged 2 commits from docs/update-init into main

2024-04-30 09:32:16 +00:00

synchon commented

2024-04-17 09:57:01 +00:00

(Migrated from github.com)

Which element of the documentation do you want to modify and why?

Every __init__.py file needs to document the purpose of the package, so it does not render like this in the API doc:

Anything else to say?

No response

### Which element of the documentation do you want to modify and why? Every `__init__.py` file needs to document the purpose of the package, so it does not render like this in the API doc: ![Screenshot 2022-11-03 at 08 53 42](https://user-images.githubusercontent.com/4493699/199662828-3e69b4d3-a9bf-4f57-aa29-6479dbd011a0.png) ### Anything else to say? _No response_

codecov[bot] commented

2024-04-17 09:58:28 +00:00

(Migrated from github.com)

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (35fe9aa) to head (6dd6fd4).

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #115   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines            1         1           
=========================================
  Hits             1         1

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

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

## [Codecov](https://app.codecov.io/gh/juaml/junifer/pull/115?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) Report All modified and coverable lines are covered by tests :white_check_mark: > Project coverage is 100.00%. Comparing base [(`35fe9aa`)](https://app.codecov.io/gh/juaml/junifer/commit/35fe9aaf4b0a5496c9eeb7a16993cb053ed31ccc?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) to head [(`6dd6fd4`)](https://app.codecov.io/gh/juaml/junifer/pull/115?dropdown=coverage&src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml). <details><summary>Additional details and impacted files</summary> [![Impacted file tree graph](https://app.codecov.io/gh/juaml/junifer/pull/115/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://app.codecov.io/gh/juaml/junifer/pull/115?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) ```diff @@ Coverage Diff @@ ## main #115 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 1 1 Lines 1 1 ========================================= Hits 1 1 ``` | [Flag](https://app.codecov.io/gh/juaml/junifer/pull/115/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) | Coverage Δ | | |---|---|---| | [docs](https://app.codecov.io/gh/juaml/junifer/pull/115/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) | `100.00% <ø> (ø)` | | 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. </details>

github-actions[bot] commented

2024-04-17 10:23:12 +00:00

(Migrated from github.com)

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-04-30 10:00 UTC

[PR Preview Action](https://github.com/rossjrw/pr-preview-action) v1.4.7 :---: Preview removed because the pull request was closed. 2024-04-30 10:00 UTC

fraimondo (Migrated from github.com) approved these changes

2024-04-29 15:13:29 +00:00