doctrine-website icon indicating copy to clipboard operation
doctrine-website copied to clipboard

Bad references should be reported instead of being ignored silently

Open jwage opened this issue 6 years ago • 4 comments

Right now if some docs have a reference to a page that doesn't exist, it just silently ignores it and leaves an empty href.

jwage avatar Apr 12 '18 23:04 jwage

With the usage of doctrine/rst-parser #233, unknown references result in an unknown anchor now. How should the reporting look like? Should there be an output in the console?

SenseException avatar Sep 11 '18 21:09 SenseException

It silently ignores the bad reference right now and outputs the unknown reference link in the HTML. @weaverryan and I have talked about adding a feature to doctrine/rst-parser that would let you throw an exception if a bad reference is encountered.

jwage avatar Sep 11 '18 22:09 jwage

That would be the (unresolved) case. So the plan is to make the build of the docs fail on a unresolvable reference?

SenseException avatar Sep 12 '18 07:09 SenseException

Yes. That is my current thought.

jwage avatar Sep 12 '18 13:09 jwage