First modification for pep237 with pydocstringformatter

[Pierre-Sassoulas]

Description

Type of Changes

	Type
✓	:scroll: Docs

Related Issue

Some results are not correct, this is the occasion to make pydocstringformatter better and to add astroid to its primer. We will handle the incorrect one in #1796

[coveralls]

Pull Request Test Coverage Report for Build 3082403333

• 34 of 34 (100.0%) changed or added relevant lines in 23 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 92.424%

---

Totals
Change from base Build 3076284340:	0.0%
Covered Lines:	9796
Relevant Lines:	10599

---

💛 - Coveralls

[DanielNoord]

@Pierre-Sassoulas Will you open issues about stuff that is broken?

[Pierre-Sassoulas]

Will you open issues about stuff that is broken?

Yes, if you think it's necessary : https://github.com/PyCQA/astroid/pull/1792#discussion_r973672856 for example would be hard to fix imo ?

I think the only clear cut one would be : https://github.com/PyCQA/astroid/pull/1792#discussion_r973673605 (only typing information without text)

[DanielNoord]

Yes, if you think it's necessary : #1792 (comment) for example would be hard to fix imo ?

https://github.com/DanielNoord/pydocstringformatter/issues/127

I think the only clear cut one would be : #1792 (comment) (only typing information without text)

I think this can also be fixed. We just need to wrap>split>period instead of split>wrap>period. Perhaps even wrap>split>wrap>period.

Something to investigate at least!

[Pierre-Sassoulas]

I created https://github.com/DanielNoord/pydocstringformatter/issues/175

I think we can"t add pydocstringformatter right now, but we might want to integrate the change that make sense right now, what do you think ?

[DanielNoord]

I think we can"t add pydocstringformatter right now, but we might want to integrate the change that make sense right now, what do you think ?

Agreed! Is this reviewable?

[Pierre-Sassoulas]

Agreed! Is this reviewable?

Not yet, I'll clean this up in the coming week

[Pierre-Sassoulas]

This is reviewable now :)

[Pierre-Sassoulas]

Arg, and there's also conflicts now. Damn.

[codecov[bot]]

Codecov Report

Merging #1792 (d00070a) into main (b717e99) will not change coverage. The diff coverage is 100.00%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1792   +/-   ##
=======================================
  Coverage   92.63%   92.63%           
=======================================
  Files          94       94           
  Lines       10869    10869           
=======================================
  Hits        10069    10069           
  Misses        800      800           

Flag	Coverage Δ
linux	92.40% <100.00%> (ø)
pypy	88.54% <100.00%> (ø)
windows	92.31% <100.00%> (ø)

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

Impacted Files	Coverage Δ
astroid/astroid_manager.py	100.00% <ø> (ø)
astroid/brain/brain_collections.py	100.00% <ø> (ø)
astroid/brain/brain_ctypes.py	100.00% <ø> (ø)
astroid/brain/brain_numpy_core_einsumfunc.py	100.00% <ø> (ø)
astroid/brain/brain_numpy_utils.py	100.00% <ø> (ø)
astroid/exceptions.py	97.56% <ø> (ø)
astroid/modutils.py	86.79% <ø> (ø)
astroid/objects.py	94.01% <ø> (ø)
astroid/test_utils.py	85.41% <ø> (ø)
astroid/transforms.py	100.00% <ø> (ø)
... and 3 more