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

Allow some inlinenodes to have child nodes #1162

Merged
merged 1 commit into from
Oct 25, 2024
Merged

Conversation

jaapio
Copy link
Member

@jaapio jaapio commented Oct 25, 2024

Markdown supports more nesting on nodes than RST does. To support this we needed to add support for compound nodes. We tried to be backward compatible for people building their own template. This layer will be removed in v2 and therfor we do trigger deprecations. See #1161

Fixes: #1160

@jaapio jaapio force-pushed the nested-inline-nodes branch 2 times, most recently from 9ee0259 to 03c3e2e Compare October 25, 2024 15:27
@jaapio jaapio requested a review from linawolf October 25, 2024 15:27
@jaapio jaapio force-pushed the nested-inline-nodes branch 2 times, most recently from c22ec47 to e3716fd Compare October 25, 2024 15:29
To support this we needed to add support for compound nodes.
We tried to be backward compatible for people building their own template.
This layer will be removed in v2 and therfor we do trigger deprecations. See #1161

Fixes: #1160
@jaapio jaapio enabled auto-merge October 25, 2024 20:18
@jaapio jaapio merged commit 6b8ce65 into main Oct 25, 2024
41 checks passed
@jaapio jaapio deleted the nested-inline-nodes branch October 25, 2024 20:20
@phpdoc-bot
Copy link

💚 All backports created successfully

Status Branch Result
1.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

phpdoc-bot added a commit that referenced this pull request Oct 25, 2024
[1.x] Merge pull request #1162 from phpDocumentor/nested-inline-nodes
use Doctrine\Deprecations\Deprecation;
use phpDocumentor\Guides\Nodes\InlineCompoundNode;

abstract class AbstractLinkInlineNode extends InlineCompoundNode implements LinkInlineNode
Copy link
Contributor

Choose a reason for hiding this comment

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

Just a fyi for next time: the change of parent class from InlineNode to InlineCompoundNode is a BC break for people that extend this base class in their code.

I've fixed this now in Symfony's alpha code, but it might be worth a notion in the release notes (and generally, I would advice to not introduce new deprecations in patch versions).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐛 Nested inline nodes are not supported
3 participants