Skip to content

docs: fix misaligned row in README.rst pre-trained models table - #20

Merged
eisDNV merged 1 commit into
mainfrom
fix/readme-rst-table
Sep 1, 2026
Merged

docs: fix misaligned row in README.rst pre-trained models table#20
eisDNV merged 1 commit into
mainfrom
fix/readme-rst-table

Conversation

@aleksandarbabicdnv

Copy link
Copy Markdown
Collaborator

Problem

The Push to main run after #19 merged fails in build_package at the Check build artifacts step (uvx twine check --strict dist/*):

Checking dist/crane_controller-0.0.1-py3-none-any.whl: FAILED
ERROR  `long_description` has syntax errors in markup and would not be rendered on PyPI.
       line 207: Error: Malformed table. Right border not aligned or missing.

pyproject.toml sets readme = "README.rst", so README.rst is the package long_description. The grid table under Pre-trained models has one misaligned row: the hybrid_cv01_s5775.zip row was one space short in its first cell, putting its column borders at 1/43/54/61 instead of the 1/44/55/62 used by every other row and border line. docutils rejects the whole table, and --strict turns that into a failure.

Cause / why it wasn't caught

Fix

One space added to the hybrid_cv01_s5775.zip row so it is 62 chars wide and its borders line up. No other changes.

Verification

docutils at twine's report level — no "Malformed table":

python -c "import docutils.core,sys; docutils.core.publish_parts(open('README.rst',encoding='utf-8').read(), writer_name='html5', settings_overrides={'report_level':2,'halt_level':5,'warning_stream':sys.stderr}); print('OK')"

Full CI-equivalent:

uv build && uvx twine check --strict dist/*
#   Checking dist/crane_controller-0.0.1-py3-none-any.whl: PASSED
#   Checking dist/crane_controller-0.0.1.tar.gz: PASSED

The `hybrid_cv01_s5775.zip` row in the grid table was one space short in
its first cell, so its column borders sat at 1/43/54/61 instead of the
1/44/55/62 used by every other row. docutils rejects the whole table
("Malformed table. Right border not aligned or missing."), which made
`twine check --strict` fail on the README (the package long_description)
in the push-to-main build_package job.

Pad the row to 62 chars so the borders line up; `twine check --strict`
now passes on both the wheel and the sdist.

@eisDNV eisDNV left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok

@eisDNV
eisDNV merged commit af7d2fc into main Sep 1, 2026
20 checks passed
@eisDNV
eisDNV deleted the fix/readme-rst-table branch September 1, 2026 09:58
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.

2 participants