Skip to content
This repository has been archived by the owner on May 31, 2021. It is now read-only.

Please remove "library" tags from Dart code. #297

Closed
Sfshaza opened this issue Jan 12, 2016 · 10 comments
Closed

Please remove "library" tags from Dart code. #297

Sfshaza opened this issue Jan 12, 2016 · 10 comments

Comments

@Sfshaza
Copy link

Sfshaza commented Jan 12, 2016

We no longer recommend that developers write an explicit library tag - a default tag is generated for you using the path/filename and is guaranteed to be unique.

@kwalrath
Copy link
Contributor

We should hold off on this change until we figure out what the story is for generating library-level API docs.

@devoncarew
Copy link
Contributor

@keertip

@kwalrath
Copy link
Contributor

The bug for the dartdoc update is here: dart-lang/dartdoc#1082. We might need other fixes, as well...

@kwalrath
Copy link
Contributor

kwalrath commented Feb 1, 2016

We've changed our mind on holding off, btw...

@devoncarew
Copy link
Contributor

PR's welcome :)

@Kleak
Copy link
Contributor

Kleak commented Feb 12, 2016

for this one the remove has to be done on the source of stagehand or also on the template source ?

@kwalrath
Copy link
Contributor

It'll require changing the template source and doing a regen. We've already applied this change to the web-angular template, btw. web-angular/lib/app_component.dart, for example, has no library directive.

@Kleak
Copy link
Contributor

Kleak commented Feb 12, 2016

not sure this is correct : https://github.com/Kleak/stagehand/tree/remove_library ?
if yes i can PR

@kwalrath
Copy link
Contributor

Go ahead and PR so I can see the diffs. Thanks!

@kwalrath
Copy link
Contributor

kwalrath commented Mar 7, 2016

Only one library directive remains, and it's warranted due to the way library docs get generated. (We could change the example to make it have another directive there, but for now...)

@kwalrath kwalrath closed this as completed Mar 7, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

No branches or pull requests

4 participants