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

removed the validate-links command line flag and related functionality #3319

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

devoncarew
Copy link
Member

@devoncarew devoncarew commented Feb 1, 2023

  • removed the validate-links command line flag and related functionality

This feature was enabled by default when running dartdoc via bin/dartdoc.dart. From testing, when generating docs for package:win32, 90% of the generation time was spent parsing and validating html which we ourselves had just generated. I don't think this feature is worth the cost.

dart doc does expose the --validate-links flag (validation is off by default). When dartdoc next rolls into the sdk we'll need to update the dart tools, changelog, etc.

@devoncarew
Copy link
Member Author

It looks like the flutter bot is failing due to the fact that we no longer support a no-validate-links cli flag. I think we should just remove the use of the flag on the next roll. (For the dart doc command, we'd likely want to keep the flag, turn it into a no-op, and warn people when it is used)

@srawlins
Copy link
Member

srawlins commented Feb 1, 2023

I think we need flutter buy-in that they are ok with removing this functionality.

I also think the functionality is useful when making changes to dartdoc. So it is good to use in our tests and development workflows, but I don't think it is very useful for end users. The only cost is time, so maybe flutter and pub think the verification is worth it. 🤷

@devoncarew
Copy link
Member Author

Ah, I assume from the error that flutter is sending in the --no-validate-links flag? I'll find the reference.

@srawlins
Copy link
Member

srawlins commented Feb 1, 2023

Oh, lol, I didn't read that closely enough. That's a big win then!

@devoncarew devoncarew changed the title removed the command line flag and related functionality removed the validate-links command line flag and related functionality Feb 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants