Repository navigation
Document Card.save's copy_files argument under its own name - #565
Open
VenishPaneliya wants to merge 1 commit into
Open
VenishPaneliya wants to merge 1 commit into
VenishPaneliya wants to merge 1 commit into
Conversation
The Parameters section still lists plot_path, which was the name proposed before the argument landed as the boolean copy_files in skops-dev#330. The description matched what copy_files does, so only the name and the flag wording needed correcting.
This branch has not been deployed
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
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.
Reference Issues/PRs
Follow-up to #330.
What does this implement/fix? Explain your changes.
Card.save'sParameterssection documentsplot_path, but the signature issave(self, path, copy_files=False)— #330 added the argument as the booleancopy_fileswhile the docstring kept the earlierplot_pathname. The description already described whatcopy_filesdoes, so this renames the entry and adjusts it from path wording to flag wording.The method is rendered through
automodule:: skops.card :members:indocs/modules/classes.rst, socopy_filesis currently undocumented there while a non-existentplot_pathis listed.Docstring only. Happy to add a
docs/changes.rstentry if you'd like one for a docs fix.