Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"Must be keyword" in Frame class docstrings? #8950

Open
ayshih opened this issue Jul 2, 2019 · 1 comment
Open

"Must be keyword" in Frame class docstrings? #8950

ayshih opened this issue Jul 2, 2019 · 1 comment

Comments

@ayshih
Copy link
Contributor

ayshih commented Jul 2, 2019

This may be a silly question, but why do many Frame class docstrings (still) say "must be keyword" for parameters that don't actually have to be keywords? It looks like an old PR noted this problem but deferred fixing it (#6219 (comment)), and a later PR claims to fix them but doesn't appear to have done anything substantial in this area (#6260 (comment)). There may be other relevant discussion that I'm unaware of.

For context, we're cleaning up docstrings on SunPy, and I'd like to know whether we should have those odd "must be keyword" clauses.

@pllim
Copy link
Member

pllim commented Jul 9, 2019

@adrn ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants