Skip to content
This repository was archived by the owner on Sep 16, 2021. It is now read-only.

[WCM] Update docs to use get/setParentDocument instead of get/setParent. #491

Closed
wants to merge 1 commit into from

Conversation

benglass
Copy link
Member

Q A
Doc fix? yes
New docs? yes (symfony-cmf/MenuBundle 1.1)
Applies to symfony-cmf/MenuBundle 1.1+

@@ -18,13 +18,13 @@ the KnpMenu component documentation for more information.

.. code-block:: php

use Symfony\Cmf\Bundle\MenuBundle\Doctrine\Phpcr\MenuNodeBase;
use Symfony\Cmf\Bundle\MenuBundle\Doctrine\Phpcr\MenuNode;

$parent = ...;

// ODM specific
$node = new MenuNodeBase();
Copy link
Member

Choose a reason for hiding this comment

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

this also needs to be changed. i would combine this section with the one below and only talk about the MenuNode and not about MenuNodeBase (that class is basically to extend in other classes).

you could convert the intro talking about base things to a sidebar or .. note:: and just explain how to use the MenuNode.

Copy link
Member Author

Choose a reason for hiding this comment

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

@dbu fixed


$parent = ...;

// ODM specific
$node = new MenuNodeBase();
$node->setParent($parent);
$node = new MenuNode();
Copy link
Member

Choose a reason for hiding this comment

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

now the title of the section is wrong ;-)

i re-copy my comment that is now hidden by github: i would combine this section with the one below and only talk about the MenuNode and not about MenuNodeBase (that class is basically to extend in other classes).

you could convert the intro talking about base things to a sidebar or .. note:: and just explain how to use the MenuNode.

Copy link
Member

Choose a reason for hiding this comment

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

I don't think we should remove the *Base document documentation. It's essential to know that the CMF does not require any third party lib

Copy link
Member Author

Choose a reason for hiding this comment

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

@dbu @wouterj This doc PR will have to wait until symfony-cmf/menu-bundle#190 is resolved (hopefully this can all happen today)

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

@wouterj i just am afraid that this will lead to confusion for the users. but if we go that way, this section should only explain how to set the label and such things that are in the Model class. and then the next section explains how to persist a doctrine menu node.

Copy link
Member

Choose a reason for hiding this comment

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

symfony-cmf/menu-bundle#191 has been merged

Copy link
Member

Choose a reason for hiding this comment

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

@dbu well, let's leave it now and see how we do that after 1.1 stable :)

Copy link
Member

Choose a reason for hiding this comment

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

okay but lets open an issue so we don't forget.

@wouterj wouterj changed the title Update docs to use get/setParentDocument instead of get/setParent. [WCM] Update docs to use get/setParentDocument instead of get/setParent. May 13, 2014
@lsmith77 lsmith77 added this to the 1.1 milestone May 14, 2014
@dbu
Copy link
Member

dbu commented May 20, 2014

this is not mergable anymore. recreated as #496

@benglass benglass closed this May 20, 2014
@wouterj wouterj deleted the use_hierarchy_interface_in_docs branch May 20, 2014 20:35
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants