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

DocGen reports the wrong return type of Converter.convert #18199

Closed
DartBot opened this issue Apr 14, 2014 · 9 comments
Closed

DocGen reports the wrong return type of Converter.convert #18199

DartBot opened this issue Apr 14, 2014 · 9 comments
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams.

Comments

@DartBot
Copy link

DartBot commented Apr 14, 2014

This issue was originally filed by bslesi...@gmail.com


According to the API doc [1], convert() has type:

  String convert(S input);

However, according to the Converters and Codecs article [2], it should be:

  T convert(S input);

I believe the article is correct and the code is wrong. If not, maybe an explanation should be added.

[1] https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/dart-convert.Converter
[2] https://www.dartlang.org/articles/converters-and-codecs/#converter

@DartBot
Copy link
Author

DartBot commented Apr 14, 2014

This comment was originally written by bslesinsk...@gmail.com


The types for the encode() and decode() methods in the Codec class also disagree with the article.

@kevmoo
Copy link
Member

kevmoo commented Apr 14, 2014

Sadly, our API doc generator has issues with generics. It ends up reporting the wrong type often.

See https://code.google.com/p/dart/issues/detail?id=17450

The return type is indeed T - https://github.com/dart-lang/bleeding_edge/blob/master/dart/sdk/lib/convert/converter.dart#L19

@kevmoo
Copy link
Member

kevmoo commented Apr 14, 2014

Added Pkg-DocGen, Area-Pkg, Triaged labels.
Changed the title to: "DocGen reports the wrong return type of Converter.convert".

@efortuna
Copy link
Contributor

efortuna commented May 9, 2014

Added Duplicate label.
Marked as being merged into #17450.

@kevmoo
Copy link
Member

kevmoo commented Jun 18, 2014

De-duping this issue. Issue #17450 is fixed for Iterable, which seemed related, but this is clearly still broken for Converter

https://api.dartlang.org/apidocs/channels/be/dartdoc-viewer/dart-convert.Converter


Removed Priority-Unassigned label.
Added Priority-High, Triaged labels.
Marked as being merged into #.

@kasperl
Copy link

kasperl commented Jul 10, 2014

Added this to the 1.6 milestone.

@sethladd
Copy link
Contributor

Marked as High, assigning owner. If I get this wrong, please help me by:

* assigning a new owner

  • changing priority
  • changing milestone

Set owner to @alan-knight.

@alan-knight
Copy link
Contributor

Removed the owner.
Removed this from the 1.6 milestone.
Removed Priority-High label.
Added Priority-Medium label.

@sethladd
Copy link
Contributor

Moved to dart-lang/dartdoc#81


Added MovedToGithub label.

@DartBot DartBot added Type-Defect area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. labels Jan 12, 2015
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams.
Projects
None yet
Development

No branches or pull requests

6 participants