Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Optional, multi-type parameters not labelled as optional in the docs #11095

Closed
gkalpak opened this issue Feb 18, 2015 · 1 comment
Closed

Optional, multi-type parameters not labelled as optional in the docs #11095

gkalpak opened this issue Feb 18, 2015 · 1 comment
Assignees
@petebacondarwin
Labels
frequency: moderate severity: confusing type: docs
Milestone
1.4.0-beta.7 / 1....

Comments

@gkalpak
Copy link
Member

gkalpak commented Feb 18, 2015

Some optional parameters to functions are not labelled as optional in the docs, inspite being documented as such. This seems to be related to the format used for optional, multi-type parameters.
E.g.:

@param {string=} xyz ...   ---> Appears correctly in the docs 
@param {(string|number)=} xyz ...   ---> Appears correctly in the docs 
@param {string|number=} xyz ...   ---> Does NOT appear correctly in the docs

(E.g. toJson's pretty parameter: docs vs source)

Could this be an issue with dgeni or should all {x|y=} occurences be replaced with {(x|y)=} ?
@gkalpak gkalpak self-assigned this Feb 18, 2015
@gkalpak gkalpak removed their assignment Feb 18, 2015
@petebacondarwin petebacondarwin self-assigned this Mar 24, 2015
@petebacondarwin petebacondarwin added this to the 1.4.0-beta.7 / 1.3.16 milestone Mar 24, 2015
petebacondarwin added a commit that referenced this issue Apr 2, 2015
@petebacondarwin
docs(toJson): improve option param documentation
5940996 
With an upgrade to dgeni-packages 0.10.13, this style of optional param
is rendered more correctly.

See #11095
@petebacondarwin
Copy link
Contributor

Got a fix in the works

petebacondarwin added a commit that referenced this issue Apr 3, 2015
@petebacondarwin
docs(toJson): improve option param documentation
560566f 
With an upgrade to dgeni-packages 0.10.13, this style of optional param
is rendered more correctly.

See #11095
petebacondarwin added a commit that referenced this issue Apr 3, 2015
@petebacondarwin
docs(toJson): improve option param documentation
66650bf 
With an upgrade to dgeni-packages 0.10.13, this style of optional param
is rendered more correctly.

See #11095
petebacondarwin added a commit that referenced this issue Apr 3, 2015
@petebacondarwin
chore(dependencies): general update (including new dgeni-packages)
830c81d 
Closes #11095
netman92 pushed a commit to netman92/angular.js that referenced this issue Aug 8, 2015
@petebacondarwin @netman92
docs(toJson): improve option param documentation
9e72357 
With an upgrade to dgeni-packages 0.10.13, this style of optional param
is rendered more correctly.

See angular#11095
netman92 pushed a commit to netman92/angular.js that referenced this issue Aug 8, 2015
@petebacondarwin @netman92
chore(dependencies): general update (including new dgeni-packages)
344d9fc 
Closes angular#11095
ggershoni pushed a commit to ggershoni/angular.js that referenced this issue Sep 29, 2015
@petebacondarwin
docs(toJson): improve option param documentation
ef23678 
With an upgrade to dgeni-packages 0.10.13, this style of optional param
is rendered more correctly.

See angular#11095
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@petebacondarwin petebacondarwin

Labels
frequency: moderate severity: confusing type: docs
Projects
None yet
Milestone
1.4.0-beta.7 / 1.3.16
Development

No branches or pull requests
2 participants
@petebacondarwin @gkalpak