Make the rake task depend only on rake #1457
Open
Conversation
This file contains 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
Without this it's necessary to require the whole library just to have the task defined. With this change `yard` will be required before executing the task code reducing the load time and memory footprint of libraries defining the task.
elia
added a commit
to nebulab/solidus
that referenced
this pull request
Sep 1, 2022
Also suggested upstream in lsegal/yard#1457.
lsegal
reviewed
Sep 3, 2022
There was a problem hiding this comment.
I'm generally worried that this advice may break plugins that rely on YARD's plugin loading features.
YARD relies heavily on autoload, and thus generally loads fairly lazily (minus the above plugin caveat), so generally speaking, the intended and recommended way to require YARD is to do so via require 'yard', pulling in any specific classes via autoload. The location of specific Ruby sources within the YARD package are generally not considered part of our "public API", and thus, requiring the YardocTask directly in this way could break if we ever moved the file.
Is there a reason why you think this is needed? Is there a specific performance issue that necessitates this change?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Without this it's necessary to require the whole library just to have
the task defined. With this change
yardwill be required beforeexecuting the task code reducing the load time and memory footprint
of libraries defining the task.
Completed Tasks
bundle exec rakelocally (if code is attached to PR).