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

Option to disable description checking #1

Open
KendallHarter opened this issue Feb 27, 2016 · 2 comments
Open

Option to disable description checking #1

KendallHarter opened this issue Feb 27, 2016 · 2 comments

Comments

@KendallHarter
Copy link
Member

It's too specific: one such example is that doc strings MUST end in '.' and not any other valid punctuation, such as '!'.
Also there are legitimate uses for wanting to start with a lowercase letter (e.g. true or false)

@JacobFischer
Copy link
Member

I agree on the other punctuation.

I can't think of when we'd want to start with a lowercase letter. The doc strings are used for all clients, and in some "true" is True (python), while in others it is true (JavaScript). People will understand what we mean and I'd rather uniformity in the doc strings.

@KendallHarter
Copy link
Member Author

Can't you just run toupper on the doc strings before passing them to the clients?
No need to force manual uppercase, and would also help with internationalization (although I'm not sure how much of an issue that is)

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

2 participants