Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Table content containing glossary tags incorrectly forces a new table row #4505

Closed
ProcessEight opened this issue May 13, 2019 · 3 comments
Closed
Assignees
Labels
2.1.x 2.2.x Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies

Comments

@ProcessEight
Copy link
Contributor

Bug report

Description

On this page: https://devdocs.magento.com/guides/v2.3/extension-dev-guide/attributes.html
In the 'Declare Extension Attributes' section, there is a table.
The second row of the table begins with 'that processes the extensions. '. However, that line of text should in fact be part of the second cell of the first row (the cell that begins with 'The fully-qualified type name with the namespace').
It appears that when the table content contains glossary tags, everything after the closing glossary tag is forced into a new table row.
See also the table rows 'ref' and 'join_on_field' in the same table.

The markdown looks syntactically correct, however:
https://github.com/magento/devdocs/blob/master/guides/v2.3/extension-dev-guide/attributes.md

Steps to reproduce

  1. Visit https://devdocs.magento.com/guides/v2.3/extension-dev-guide/attributes.html
  2. Review the 'Declare Extension Attributes' table
  3. Note that the rows underneath the rows beginning with 'for', 'ref', 'join_on_field' all contain the rest of the sentence started in the second column of the previous row.

Expected result

The text in the first row, second column should read 'The fully-qualified type name with the namespace that processes the extensions. The value must be a type that implements ExtensibleDataInterface. The interface can be in a different module.', as it is defined in the markdown file. The text in the first row, third column should read 'Magento\Quote\Api\Data\TotalsInterface', again as it is defined in the markdown file.

Possible solutions

Additional information

@jcalcaben
Copy link
Contributor

A possible solution for this would be to remove the surrounding glossary tag.

@jcalcaben jcalcaben added Progress: good first issue Good issue to take on if you are new to the devdocs repo Help Wanted Help wanted for issue/PR labels May 14, 2019
vasilii-b pushed a commit to vasilii-b/devdocs that referenced this issue May 22, 2019
dobooth added a commit that referenced this issue May 28, 2019
…es-glossary-tooltip-inside-table

Bugfix for #4505 - Table content containing glossary tags incorrectly forces a new table row
@shrielenee shrielenee removed Help Wanted Help wanted for issue/PR Progress: good first issue Good issue to take on if you are new to the devdocs repo labels Jun 25, 2019
@shrielenee shrielenee self-assigned this Jun 25, 2019
@shrielenee shrielenee added 2.1.x 2.2.x Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies labels Jun 25, 2019
@shrielenee
Copy link
Contributor

shrielenee commented Jun 25, 2019

This issue appears to have been resolved for v2.3 via #4584. I will make any table fixes (there are some issues in the 2.2 version).

dobooth added a commit that referenced this issue Jun 26, 2019
GitHub issue #4505: Fix table formatting and link issues
@shrielenee
Copy link
Contributor

This has been fixed in #4834 - closing.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
2.1.x 2.2.x Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies
Projects
None yet
Development

No branches or pull requests

3 participants