Updated misleading documentation about word_margin #407
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.
Pull request
As per #390 (comment) and #390 (comment), updates the documentation for
char_margin
andword_margin
.Closes #390
I noticed that the docs in
converting_pdf_to_text.rst
were actually more correct in terms of what each parameter does (and this is now consistent in the other files). However I'm fairly sure some of the logic about makingword_margin
smaller/larger was slightly wrong, please check this as it does take some thinking about.. In my head, smaller word margin means there doesn't need to be as much of a gap between chars for a space to be inserted, i.e. you get more, shorter words.Your comment also said to update
tools/pdfdiff.py
but actually the documentation here doesn't contain the detail. Perhaps it's taken from the other files or something?How Has This Been Tested?
Documentation changes can't really be tested
Checklist
works (N/A)
version
is not necessary
verified that this is not necessary
CHANGELOG.md