Skip to content

dgeni is too harsh ! #949

@vicb

Description

@vicb

Background: I've just broken the build by adding some documentation...

But I think dgeni is too harsh.

I think we should encourage adding documentation and may be dgeni does not help here. This is the error I had:

error:   Error processing docs:  expected=["!", "(", "=", "?", "[]", "|"], found=W, offset=8, line=1, column=9, name=SyntaxError, message=Error running processor "extractTagsProcessor":
Expected "!", "(", "=", "?", "[]" or "|" but "W" found.
[18:46:31] 'docs/dgeni' errored after 1.82 s
[18:46:31] Error: SyntaxError: Error running processor "extractTagsProcessor":
Expected "!", "(", "=", "?", "[]" or "|" but "W" found.
    at formatError (/usr/local/lib/node_modules/gulp/bin/gulp.js:169:10)
    at Gulp.<anonymous> (/usr/local/lib/node_modules/gulp/bin/gulp.js:195:15)
    at Gulp.EventEmitter.emit (events.js:95:17)
    at Gulp.Orchestrator._emitTaskDone (/home/victor/dart/angular/node_modules/gulp/node_modules/orchestrator/index.js:264:8)
    at /home/victor/dart/angular/node_modules/gulp/node_modules/orchestrator/index.js:275:23
    at finish (/home/victor/dart/angular/node_modules/gulp/node_modules/orchestrator/lib/runTask.js:21:8)
    at /home/victor/dart/angular/node_modules/gulp/node_modules/orchestrator/lib/runTask.js:45:4
    at _rejected (/home/victor/dart/angular/node_modules/dgeni/node_modules/q/q.js:808:24)
    at /home/victor/dart/angular/node_modules/dgeni/node_modules/q/q.js:834:30
    at Promise.when (/home/victor/dart/angular/node_modules/dgeni/node_modules/q/q.js:1079:31)
  • Could we make the error message clearer by making explicit what is wrong & where ?
  • Could it be a warning rather than an error ?
  • What about some documentation on what is the expected format (ie in CONTRIBUTING.md) ?

edit: and by the way my issue should probably be fixed in a nicer way.

Metadata

Metadata

Labels

featureLabel used to distinguish feature request from other issues

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions