docs(repository.diff): fix docstring keyword 'flag' -> 'flags'#1460
Open
MukundaKatta wants to merge 1 commit intolibgit2:masterfrom
Open
docs(repository.diff): fix docstring keyword 'flag' -> 'flags'#1460MukundaKatta wants to merge 1 commit intolibgit2:masterfrom
MukundaKatta wants to merge 1 commit intolibgit2:masterfrom
Conversation
The BaseRepository.diff signature takes 'flags: DiffOption = ...', not 'flag', but the docstring's Keyword arguments block listed 'flag'. Closes libgit2#1138
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
1 participant
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.
Summary
`BaseRepository.diff` signature takes `flags: DiffOption = DiffOption.NORMAL`, but its docstring's Keyword arguments block described the parameter as `flag` (singular). The overload stubs in `pygit2/_pygit2.pyi` also use `flags`. Fixed the docstring to match.
Closes #1138
Testing
Docstring-only change.