docs, cmd: fix broken docs source links regression in vdoc#23889
Merged
Conversation
|
Connected to Huly®: V_0.6-22292 |
Delta456
reviewed
Mar 9, 2025
Comment on lines
+316
to
+317
| } else if cfg.is_vlib { | ||
| assert false, 'vdoc: manifest does not exists for vlib' |
Member
There was a problem hiding this comment.
I believe eprintln can function better here, followed by an exit as done above.
Contributor
Author
There was a problem hiding this comment.
The idea is to ensure that we do not let this happen again when the code base is worked upon - it is not (/should not be) a vdoc runtime error IMO. An invalid / unreadable manifest_file results in bad side-effects when vlib's own docs are generated, an assert is a way to prevent it longer term. I don't currently see how to put his in a test where it would probably fit better?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Locally running
v doc -m -f html -o ./tmpdocs vlib/ && firefox tmpdocs/builtin.htmlnow results in source links showed:I'm unsure about how to add a regression test 🤔
Maybe we could do an
assertsomewhere ifcfg.is_vlib == true🤷