Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated misleading documentation about word_margin #407

Merged

Conversation

jstockwin
Copy link
Member

Pull request

As per #390 (comment) and #390 (comment), updates the documentation for char_margin and word_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 making word_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

  • I have added tests that prove my fix is effective or that my feature
    works (N/A)
  • I have added docstrings to newly created methods and classes
  • I have optimized the code at least one time after creating the initial
    version
  • I have updated the README.md or I am verified that this
    is not necessary
  • I have updated the readthedocs documentation or I
    verified that this is not necessary
  • I have added a consice human-readable description of the change to
    CHANGELOG.md

@jstockwin jstockwin force-pushed the fix-misleading-word-margin-docs branch from 8c296b1 to 5d81e8e Compare March 26, 2020 10:33
@pietermarsman pietermarsman merged commit 518b5d6 into pdfminer:develop Mar 26, 2020
@jstockwin jstockwin deleted the fix-misleading-word-margin-docs branch March 27, 2020 08:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Iconsistent layout, misbehaving file(maybe unicode related?)
2 participants