revert `IgnoreParser._parse_rule_file` to `parse_rule_file` as documented

ITProKyle commented 2 years ago

Please check if the Pull Request fulfills these requirements
[x] The commit message follows our guidelines
[x] Tests for the changes have been added (for bug fixes / features)
[x] Docs have been added / updated (for bug fixes / features)
What kind of change does this Pull Request introduce? (Bug fix, feature, docs update, ...)

Bug fix

What is the current behavior? (You can also link to an open issue here)

resolves #22

This is something that tripped me up when first using this library as the documented method does not exist. I would rather have the method changed back to a public method than updating the docs to remove the reference as being able to add a gitignore file that is known to exist is more efficient than having it recursively search directories to find it (again).

What is the new behavior (if this is a feature change)?

A method with signature IgnoreParser.parse_rule_file(self, rule_file: PathLikeOrString) -> None. In addition to reverting the name change of the method, the base_dir was removed as it is not used by the method.

Does this Pull Request introduce a breaking change? (What changes might users need to make in their application due to this PR?)

Yes but the breaking change is to a protected method so a major release should not be required. Users will just need to change the name of the method being called from _parse_rule_file to parse_rule_file.

bitranox commented 2 years ago

since my toolchain is broken atm, release will be done later ... thanks for Your contribution !

bitranox commented 2 years ago

released and put on pypi - thanks again for Your valuable contribution !

bitranox / igittigitt

revert `IgnoreParser._parse_rule_file` to `parse_rule_file` as documented #25