Add a getSampleProblemCode method to SampleProblemParser.pm.
#1198
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
This method is much more efficient than calling `parseSampleProblem` to obtain the code as it does not parse documentation, does not require that the sample problem metadata be parsed first, and it does not need macro POD information. Note that to obtain the code via the `parseSampleProblem` method, 253 files need to be read and parsed (all sample problems and all macros). The `getSampleProblemCode` method only needs to read 1 file, and the parsing of that is more efficient as well. It should be used if all you want is the code as it does not return the documentation and other data returned by the `parseSampleProblem` method. Also remove the unused `$macro_locations` argument to the `parseMetadata` method. These changes are used to implement sample problem editing in the PG problem editor for webwork2 in a corresponding pull request.
drgrice1
force-pushed
the
sample-problem-get-code
branch
from
a5428ee to
1e1695a
Compare
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
This method is much more efficient than calling
parseSampleProblemto obtain the code as it does not parse documentation, does not require that the sample problem metadata be parsed first, and it does not need macro POD information. Note that to obtain the code via theparseSampleProblemmethod, 253 files need to be read and parsed (all sample problems and all macros). ThegetSampleProblemCodemethod only needs to read 1 file, and the parsing of that is more efficient as well. It should be used if all you want is the code as it does not return the documentation and other data returned by theparseSampleProblemmethod.Also remove the unused
$macro_locationsargument to theparseMetadatamethod.These changes are used to implement sample problem editing in the PG problem editor for webwork2 in openwebwork/webwork2#2677.