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

Amateja updates #27

Merged
merged 49 commits into from May 3, 2022
Merged

Amateja updates #27

merged 49 commits into from May 3, 2022

Conversation

thclark
Copy link
Owner

@thclark thclark commented May 3, 2022

Contents (#27)

Incorporates extensive and excellent work from @amateja - Thanks very much Andrzej!

Features

  • Use tabulate to replace table handling code as suggested in Update crummy table management #9.
    BREAKING CHANGE: tabulate is now a dependency.
  • Add list-table support
  • Store reStructuredText data into stream instead of list (faster, especially if piping into a file)
    BREAKING CHANGE: The RstCloth().data property is no longer a list but a stream
  • List table width and widths options expansion
  • Admonitions added
  • Bibliographic fields added
  • Raw directives added
  • Contents directive added
  • Transition marker added

Enhancements

  • Field structure and wrapping improved
    BREAKING-CHANGE: Indentation and wrapping may change (although all documents should still render)
  • Table indentation improved
  • Parameter type verification changed to type declaration
  • Type annotations added and docstrings supplemented
  • Quick start documentation updated and unified

Fixes

  • Fixed incorrect formatting of long bullet list point
  • Paragraph folding fixed
  • Directive folding fixed
  • Bullet list item wrapping fixed
  • Footnote reference should end with _

Refactoring

  • Replaced different header methods with generic template
  • Drop unused wrap parameter
  • Reusing existing code for hyperlink formatting
  • Variables names refactoring
  • Drop unused BaseTestCase class
  • Drop unused Table class
  • YAML table translator removed

Testing

  • Basic tests of RstCloth.table method added

@codecov-commenter
Copy link

Codecov Report

❗ No coverage uploaded for pull request base (main@721e1be). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff            @@
##             main       #27   +/-   ##
========================================
  Coverage        ?   100.00%           
========================================
  Files           ?         3           
  Lines           ?       206           
  Branches        ?         0           
========================================
  Hits            ?       206           
  Misses          ?         0           
  Partials        ?         0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 721e1be...b2120c4. Read the comment docs.

BREAKING-CHANGE: Uncategorised commits contain breaking changes including the use of tabulate as a dependency and refactor to use stream rather than list, as well as substantive changes to wrapping and line termination defaults
@thclark thclark merged commit 26308a8 into main May 3, 2022
@thclark thclark deleted the amateja-updates branch May 3, 2022 17:09
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.

None yet

3 participants