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

[BUGFIX] Display external pages on all levels of the main menu #900

Merged
merged 2 commits into from
Mar 12, 2024

Conversation

linawolf
Copy link
Contributor

@linawolf linawolf commented Mar 4, 2024

Sphinx handels it also that way

@jaapio
Copy link
Member

jaapio commented Mar 4, 2024

I will have to review this more in depth, but it looks like there are a number of breaking changes in this pr.

Will come back to this later

@linawolf
Copy link
Contributor Author

linawolf commented Mar 5, 2024

All places that use now DocumentEntryNode|ExternalEntryNode before used DocumentEntryNode so it shouldn't really be breaking.

Also as the Transformers are final they should not have been extended so we do not need to worry there.

I introduced a new level of inheritence in Nodes, however now the DocumentEntryNode extends the EntryNode which extends the AbstractNode, before it extended the AbstractNode directly. This should also be not breaking.

There is a slight possibility that someone expects all children of DocumentEntryNode to be DocumentEntryNode. And now this only returns an EntryNode. We could instead of altering getChildren introduce a new method and let getChildren filter only for DocumentEntryNodes?

Copy link
Member

@jaapio jaapio left a comment

Choose a reason for hiding this comment

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

To be fair, we just released 1.0.0. So I do not expect anyone to use this functionality in to much depth, and the breaking change is limited. But I would like to get some awareness around the things that have been changed.

Stretching the arguments of methods is ok, people using the methods directly will not be impacted as we still accept the same types as before. The changes in the compiler passes should also not really impact people.

Changing return types is a no go, as I explained in the review comments. I would like to be constructive in this and not to strict. But I also want to ensure that we are all strict on these type of changes.

@linawolf
Copy link
Contributor Author

linawolf commented Mar 9, 2024

@jaapio I have some questions, see above

@jaapio jaapio merged commit 3ddcbbd into main Mar 12, 2024
38 checks passed
@jaapio jaapio deleted the task/menu-external branch March 12, 2024 20:53
@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 Mar 12, 2024
[1.x] Merge pull request #900 from phpDocumentor/task/menu-external
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.

3 participants