docs: more args and returns documentation in DataFrame class

[marenwestermann]

What type of PR is this? (check all applicable)

• 💾 Refactor
• ✨ Feature
• 🐛 Bug Fix
• 🔧 Optimization
• 📝 Documentation
• ✅ Test
• 🐳 Other

Related issues

• Related issue docs: return values don't show up in docs #1293
• Closes #<issue number>

Checklist

• Code follows style guide (ruff)
• Tests added
• Documented the changes

If you have comments or can explain your changes, please do so below

I keep chipping away at this. :)

[MarcoGorelli]

we don't need Self, the type annotation already shows up in the docs

[marenwestermann]

I addressed the comment and finished the documentation for the Dataframe class. As a number of methods just return Self I think it wasn't really necessary to document what gets returned in these but I did it for consistency and also because I think it adds a bit of clarification in some places.

But anyway, let me know what you think. I don't feel super confident about the documentation.

[MarcoGorelli]

yay thanks @marenwestermann !

[MarcoGorelli]

As a number of methods just return Self I think it wasn't really necessary to document what gets returned

the advantage of having at least something is that then it shows up in the rendered docs - I think simple phrases like the ones you've added are all that's needed 👍