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

Fix documentation and method name for FootnoteProperties #1776

Merged
merged 2 commits into from Dec 9, 2019

Conversation

mdupont
Copy link
Contributor

@mdupont mdupont commented Dec 9, 2019

Description

  • Fixed documentation about FootnoteProperties which contained an invalid code snippet, so that people can actually use the code:
    • it now uses the correct class names
    • no more typo in variable name usage
    • now uses a Footnote position parameter that works when outputting Word (POSITION_BENEATH_TEXT). POSITION_DOC_END only works for Endnotes.
  • Fixed bogus method name $section->addFootnotePropoperties():
    • added a method with the correct spelling $section->addFootnoteProperties()
    • former method still works but is marked as deprecated
    • migrated code to use the correct method name

Checklist:

  • I have run composer run-script check --timeout=0 and no errors were reported
  • The new code is covered by unit tests (check build/coverage for coverage report)
  • I have updated the documentation to describe the changes

Michaël Dupont added 2 commits December 9, 2019 11:29
Was "getFootnotePropoperties()".
Former bogus spelling is still working, albeit deprecated.
The documentation contained an incorrect code snippet for
configuring FootnoteProperties. Now the code is valid.
@coveralls
Copy link

Coverage Status

Coverage remained the same at 94.633% when pulling cb3e211 on mdupont:footnotes-typo into dfea4e1 on PHPOffice:develop.

@troosan troosan merged commit 733f845 into PHPOffice:develop Dec 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants