Clarify PCK path argument in PCKPacker.pck_start
#97286
Merged
+10
−10
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
AThousandShips
changed the title
PCKPacker.pck_start
AThousandShips
added
enhancement
documentation
cherrypick:4.2
Mickeon
approved these changes
Sep 21, 2024
There was a problem hiding this comment.
I checked the source code and I can confirm the reasoning to be correct.
Note that for the related function add_file, the parameter is exposed as pck_path, and that internally the parameter is actually called p_file. If possible, we should be renaming the exposed parameter. It may have been an oversight.
|
I also noted the source code differences, but I didn't want to modify that since I'm not super confident in my C++ quite yet. |
akien-mga
changed the title
PCKPacker.pck_startPCKPacker.pck_start
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
|
I went ahead and changed the name of the argument too to be clearer, as |
akien-mga
approved these changes
Sep 23, 2024
|
Thanks! And congrats for your first merged Godot contribution 🎉 |
akien-mga
removed
the
cherrypick:4.2
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.
The pck_start() function description was somewhat misleading, and lead to some confusion until I (with some help) figured out that the pck_name argument actually represents the entire file path for the .pck file.
Changed "with the name
pck_name" to "at the file pathpck_name" so that the description is more clear, and should not lead to any confusion as to where the .pck file is output.