Skip to content

Broken table formatting in documentation #3336

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.

Sign up for GitHub

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

Jump to bottom
Closed
andreas-kupries opened this issue Feb 15, 2023 · 4 comments
Closed

Broken table formatting in documentation #3336

andreas-kupries opened this issue Feb 15, 2023 · 4 comments
Labels
bug

Comments

@andreas-kupries
Copy link
Contributor

Bug report

Describe the bug

Table formatting at https://www.libvips.org/API/current/libvips-create.html#vips-buildlut is broken.
It shows as

For example, consider this 2 x 2 matrix of (x, y) coordinates:

<tgroup cols='2' align='left' colsep='1' rowsep='1'> <tbody> <row> <entry>0</entry> <entry>0</entry> </row> <row> <entry>255</entry> <entry>100</entry> </row> </tbody> </tgroup>

We then generate:

<tgroup cols='2' align='left' colsep='1' rowsep='1'> <thead> <row> <entry>Index</entry> <entry>Value</entry> </row> </thead> <tbody> <row> <entry>0</entry> <entry>0</entry> </row> <row> <entry>1</entry> <entry>0.4</entry> </row> <row> <entry>...</entry> <entry>etc. by linear interpolation</entry> </row> <row> <entry>255</entry> <entry>100</entry> </row> </tbody> </tgroup>

This is then written as the output image, with the left column giving the index in the image to place the value.

This looks to me as if the table tags got overquoted to make them look like ordinary text.

To Reproduce

Referenced page was visited and read with a browser (firefox, although likely not brower-dependent).

Expected behavior

To see a proper table

Actual behavior

Table formatting shows as ordinary text

Screenshots

n/a

Environment

n/a, docs issue

Additional context

n/a
@andreas-kupries andreas-kupries changed the title A concise title of what the bug is. Broken table formatting in documentation Feb 15, 2023
@andreas-kupries
Copy link
Contributor Author

Ditto https://www.libvips.org/API/current/libvips-create.html#vips-invertlut

jcupitt added a commit that referenced this issue Feb 15, 2023
@jcupitt
fix buildlut docs
5984718 
The docbook table is no longer supported, so it's ascii art now.

See #3336
jcupitt added a commit that referenced this issue Feb 15, 2023
@jcupitt
fix invertlut docs
870f9e5 
The table docbook markup is no longer supported, so it's ascii art.

See #3336
@jcupitt
Copy link
Member

jcupitt commented Feb 15, 2023

Argh, the old docbook markup is no longer supported in current gtkdoc. I've redone them in ascii art, thanks!

@jcupitt
Copy link
Member

jcupitt commented Feb 15, 2023

There are a few others that need fixing too:

~/GIT/libvips/libvips (master) $ grep -l tgroup */*.c
arithmetic/add.c
arithmetic/arithmetic.c
arithmetic/divide.c
arithmetic/multiply.c
arithmetic/subtract.c
arithmetic/sum.c
deprecated/im_lab_morph.c

@andreas-kupries
Copy link
Contributor Author

Just seen, the See Also section of
https://www.libvips.org/API/current/libvips-generate.html#vips-image-pipelinev

kleisauke added a commit to kleisauke/libvips that referenced this issue Sep 12, 2024
@kleisauke
Fix markup in generated gtk-doc
fdd4336 
Resolves: libvips#3336.
@kleisauke kleisauke mentioned this issue Sep 12, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@andreas-kupries @jcupitt