DOC: Fixes to docstrings and add PR10 (space before colon) to validation
State: closed

- Closes #25104
- added type set_option docstring in config.py
-added type to boxplot_frame_groupby docstring in plotting/_core.py
-indented versionadded in ExcelWriter docstring io/excel.py
-updated code_check.sh to take into account PR10 type errors

Labels:
name: Docs

Comments:
# [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/25109?src=pr&el=h1) Report
> Merging [#25109](https://codecov.io/gh/pandas-dev/pandas/pull/25109?src=pr&el=desc) into [master](https://codecov.io/gh/pandas-dev/pandas/commit/f75a220ff1e5e027ef2b070430fd7f4490cdcbf0?src=pr&el=desc) will **not change** coverage.
> The diff coverage is `n/a`.

[![Impacted file tree graph](https://codecov.io/gh/pandas-dev/pandas/pull/25109/graphs/tree.svg?width=650&token=eZ4WkYLtcO&height=150&src=pr)](https://codecov.io/gh/pandas-dev/pandas/pull/25109?src=pr&el=tree)

```diff
@@           Coverage Diff           @@
##           master   #25109   +/-   ##
=======================================
  Coverage   92.37%   92.37%           
=======================================
  Files         166      166           
  Lines       52415    52415           
=======================================
  Hits        48418    48418           
  Misses       3997     3997
```

| Flag | Coverage Δ | |
|---|---|---|
| #multiple | `90.79% <ø> (ø)` | :arrow_up: |
| #single | `42.87% <ø> (ø)` | :arrow_up: |

| [Impacted Files](https://codecov.io/gh/pandas-dev/pandas/pull/25109?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [pandas/plotting/\_core.py](https://codecov.io/gh/pandas-dev/pandas/pull/25109/diff?src=pr&el=tree#diff-cGFuZGFzL3Bsb3R0aW5nL19jb3JlLnB5) | `83.58% <ø> (ø)` | :arrow_up: |
| [pandas/core/config.py](https://codecov.io/gh/pandas-dev/pandas/pull/25109/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvY29uZmlnLnB5) | `87.04% <ø> (ø)` | :arrow_up: |

------

[Continue to review full report at Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/25109?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/25109?src=pr&el=footer). Last update [f75a220...6d6e054](https://codecov.io/gh/pandas-dev/pandas/pull/25109?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).

# [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/25109?src=pr&el=h1) Report
> Merging [#25109](https://codecov.io/gh/pandas-dev/pandas/pull/25109?src=pr&el=desc) into [master](https://codecov.io/gh/pandas-dev/pandas/commit/683c7b55f5195fdf4f524239066cbf6f1301f0e7?src=pr&el=desc) will **not change** coverage.
> The diff coverage is `n/a`.

[![Impacted file tree graph](https://codecov.io/gh/pandas-dev/pandas/pull/25109/graphs/tree.svg?width=650&token=eZ4WkYLtcO&height=150&src=pr)](https://codecov.io/gh/pandas-dev/pandas/pull/25109?src=pr&el=tree)

```diff
@@           Coverage Diff           @@
##           master   #25109   +/-   ##
=======================================
  Coverage   92.34%   92.34%           
=======================================
  Files         166      166           
  Lines       52314    52314           
=======================================
  Hits        48311    48311           
  Misses       4003     4003
```

| Flag | Coverage Δ | |
|---|---|---|
| #multiple | `90.78% <ø> (ø)` | :arrow_up: |
| #single | `42.84% <ø> (ø)` | :arrow_up: |

| [Impacted Files](https://codecov.io/gh/pandas-dev/pandas/pull/25109?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [pandas/plotting/\_core.py](https://codecov.io/gh/pandas-dev/pandas/pull/25109/diff?src=pr&el=tree#diff-cGFuZGFzL3Bsb3R0aW5nL19jb3JlLnB5) | `83.58% <ø> (ø)` | :arrow_up: |
| [pandas/core/config.py](https://codecov.io/gh/pandas-dev/pandas/pull/25109/diff?src=pr&el=tree#diff-cGFuZGFzL2NvcmUvY29uZmlnLnB5) | `87.04% <ø> (ø)` | :arrow_up: |

------

[Continue to review full report at Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/25109?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/pandas-dev/pandas/pull/25109?src=pr&el=footer). Last update [683c7b5...fc8b1c4](https://codecov.io/gh/pandas-dev/pandas/pull/25109?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).

@victormoron are the fixes to the docstrings failing because of the PR10 error? The fixes are correct, but seem unrelated. In general try to keep one PR per concept, if PR10 can already be validated, would be better to have it in a separate PR. If they are related, I think the validation is not working as expected.
@datapythonista. Basically the problem was not related with the fact of the space after the variable name, was related with the type not being defined. I firstly tried to delete the colon as suggested in the documentation, but then error was raised as type was required. I finally added the type of variable to get rid of the colon space problem. Hope that answers the question.

Should I update your suggestions and do another PR? 
Looks like the validation script reported PR10 for some false positives then, I wasn't aware. That would belong to another PR, if you can address the comments, happy to get this merged.
@datapythonista  should be ok now. let me know
thanks @victormoron