docs: add missing methods in api reference #1144
Conversation
AlessandroMiola
changed the title
github-actions
bot
added
the
documentation
utils/check_api_reference.py
Outdated
| @@ -121,6 +121,72 @@ | |||
| print(extra) # noqa: T201 | |||
| ret = 1 | |||
|
|
|||
| # Series.cat methods | |||
There was a problem hiding this comment.
is it possible to loop over ['cat', 'dt', 'str', 'name'] for these? there's a lot of repetition currently
There was a problem hiding this comment.
Sure! If I'm not wrong, "name" isn't a real namespace for Series as it is for Expr, so I excluded it from the loop. lmk if that's ok or if I am missing something.
There was a problem hiding this comment.
Thanks @AlessandroMiola ! This is amazing!
If you fancy, as follow up we could also add a check for the difference between Expr vs Series namespaces internal methods, similar to what already happens in lines 212-229
Yep, sure. Sorry, forgot it earlier 🥶 |
…#1144) * docs: add check on Series.dt methods being in api-reference * docs: add check on Series.cat methods being in api-reference * chore: remove extra blanks * docs: add check on documented, yet no longer existent methods on dtype * docs: add check on Expr.{cat, dt, name, str} methods being in api-reference * chore: remove useless check and move checks on Series.{cat, dt, str} higher up * docs: apply suggested changes
What type of PR is this? (check all applicable)
Related issues
Checklist
If you have comments or can explain your changes, please do so below.
Extends
utils/check_api_reference.pyto include methods fromSeries.cat,Series.dt,Expr.cat,Expr.dt,Expr.nameandExpr.str. (Hope I haven't missed anything:))