Skip to content

DOC: docstrings of is_type_factory and is_instance_factory in config.py not accurate. #15485

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

Closed
fumitoh opened this issue Feb 23, 2017 · 5 comments · Fixed by #15499
Closed
Labels
Milestone

Comments

@fumitoh
Copy link
Contributor

fumitoh commented Feb 23, 2017

The validators returned by the functions don't return True, contrary to the docstrings' descriptions.

@fumitoh fumitoh changed the title DOC: docstrings of is_type_factory and is_instance_factory not accurate. DOC: docstrings of is_type_factory and is_instance_factory in config.py not accurate. Feb 23, 2017
@jreback
Copy link
Contributor

jreback commented Feb 23, 2017

@fumitoh exactly what are you referring?

@fumitoh
Copy link
Contributor Author

fumitoh commented Feb 24, 2017

here and here

Both inner s return None.

@jreback
Copy link
Contributor

jreback commented Feb 24, 2017

but how is this incorrect?
the doc string says it's returning a function which it is; not the result of the function

@fumitoh
Copy link
Contributor Author

fumitoh commented Feb 24, 2017

The doc string says:

Returns
-------
validator - a function of a single argument x , which returns the
            True if type(x) is equal to `_type`

The validator does not return True. It's just for raising an error when invalid type objects are passed.

@jreback
Copy link
Contributor

jreback commented Feb 24, 2017

ok if you'd like to do a PR to fix would be fine

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

Successfully merging a pull request may close this issue.

2 participants