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.

Sign up for GitHub

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

Jump to bottom

sphinx: optional properties or arguments are described with "or undefined" instead of "(optional)" #300

Closed
eladb opened this issue Nov 8, 2018 · 0 comments
Closed

sphinx: optional properties or arguments are described with "or undefined" instead of "(optional)" #300

eladb opened this issue Nov 8, 2018 · 0 comments

Comments

@eladb
Copy link
Contributor

eladb commented Nov 8, 2018

No description provided.

eladb pushed a commit that referenced this issue Nov 8, 2018
fix(docs): improve docs rendering
2888b56 
Fixes #301: reject non-optional arguments after optional arguments
Fixes #298: show default values for optional properties
Fixes #302: omit "abstract" from interface properties (they are by definition abstract)
Fixes #300: indicate optionals with "optional" instead of "or undefined"
Fixes #299: render multiple jsdoc lines as multiple lines in sphinx
@eladb eladb mentioned this issue Nov 8, 2018
Merged
@eladb eladb closed this as completed in #303 Nov 8, 2018
eladb pushed a commit that referenced this issue Nov 8, 2018
fix(docs): improve docs rendering (#303)
094a215 
Fixes #301: reject non-optional arguments after optional arguments
Fixes #298: show default values for optional properties
Fixes #302: omit "abstract" from interface properties (they are by definition abstract)
Fixes #300: indicate optionals with "optional" instead of "or undefined"
Fixes #299: render multiple jsdoc lines as multiple lines in sphinx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@eladb