Skip to content

Commit

Permalink
Update contributing guide, fix minor documentation errors.
Browse files Browse the repository at this point in the history
  • Loading branch information
tanujjain committed Oct 31, 2019
1 parent aba9017 commit 153fae0
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -12,14 +12,14 @@ Please read this guide before making any contributions.
The feedback should be submitted by creating an issue on [GitHub issues](https://github.com/idealo/image-dedup/issues).
Select the related template (bug report, feature request, or custom) and add the corresponding labels.

#### Fix Bugs:
#### Fix Bugs
You may look through the [GitHub issues](https://github.com/idealo/image-dedup/issues) for bugs.

#### Implement Features
You may look through the [GitHub issues](https://github.com/idealo/image-dedup/issues) for feature requests.

## Pull Requests (PR)
1. Fork the repository and create a new branch from the master branch.
1. Fork the repository and create a new branch from the `dev` branch.
2. For bug fixes, add new tests and for new features, please add changes to the documentation.
3. Do a PR from your new branch to our `dev` branch of the original Imagededup repo.

Expand Down
4 changes: 1 addition & 3 deletions mkdocs/docs/user_guide/finding_duplicates.md
Expand Up @@ -149,9 +149,7 @@ The 'method-name' corresponds to one of the deduplication methods available and

- *encoding_map*: Optional, used instead of image_dir attribute. Set it equal to the dictionary of file names and
corresponding encodings (hashes/cnn encodings). The mentioned dictionary can be generated using the corresponding
[*encode_images*](encoding_generation.md) method. Each key in the 'duplicates' dictionary corresponds to a file in the image directory passed to
the image_dir parameter of the find_duplicates function. The value is a list of all tuples representing the file names
and corresponding scores in the image directory that were found to be duplicates for the key file.
[*encode_images*](encoding_generation.md) method.

- *outfile*: Name of file to which the returned duplicates dictionary is to be written, must be a json. *None* by default.

Expand Down

0 comments on commit 153fae0

Please sign in to comment.