Section children
6 views
Skip to first unread message
James Coglan
Jan 7, 2010, 3:03:38 PM1/7/10
to pd...@googlegroups.com
Hi all,
There's an ongoing issue with section children that I'm partly fixing right now (commits will be on Github shortly). Basically, since you can label any namespace as belonging to any section, there is not a strict hierarchical relationship between sections and namespaces. e.g. in JS.Class the 'JS' and 'JS.Class' namespaces are in the 'core' section, whereas the 'JS.Test' namespace (a child of 'JS') is in the 'test' section.
The first fix is to make sure all namespaces get pages rendered -- I've taken care of this. The second (trickier) thing is to make sure all namespaces get rendered in the sidebar. It's a fairly common pattern for a large JS project (e.g. Dojo, YUI) to use a single root namespace object but it could still be split into sections, so assigning the root namespace object as a child of a single section causes problems. Maybe this relationship needs rethinking, so I'm inviting suggestions before hacking a solution myself.
--
James Coglan
http://jcoglan.com
+44 (0) 7771512510
There's an ongoing issue with section children that I'm partly fixing right now (commits will be on Github shortly). Basically, since you can label any namespace as belonging to any section, there is not a strict hierarchical relationship between sections and namespaces. e.g. in JS.Class the 'JS' and 'JS.Class' namespaces are in the 'core' section, whereas the 'JS.Test' namespace (a child of 'JS') is in the 'test' section.
The first fix is to make sure all namespaces get pages rendered -- I've taken care of this. The second (trickier) thing is to make sure all namespaces get rendered in the sidebar. It's a fairly common pattern for a large JS project (e.g. Dojo, YUI) to use a single root namespace object but it could still be split into sections, so assigning the root namespace object as a child of a single section causes problems. Maybe this relationship needs rethinking, so I'm inviting suggestions before hacking a solution myself.
--
James Coglan
http://jcoglan.com
+44 (0) 7771512510
Tobie Langel
Jan 7, 2010, 5:21:47 PM1/7/10
to pd...@googlegroups.com
As I told you earlier, I have a huge bunch of commits comming up which will break backwards compatibility.
Can you please delay committing your changes?
Thanks.
Tobie
Sent from my mobile phone.
Sent from my mobile phone.
--
You received this message because you are subscribed to the Google Groups "PDoc" group.
To post to this group, send email to pd...@googlegroups.com.
To unsubscribe from this group, send email to pdoc+uns...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/pdoc?hl=en.
James Coglan
Jan 7, 2010, 5:51:49 PM1/7/10
to pd...@googlegroups.com
2010/1/7 Tobie Langel <tobie....@gmail.com>
As I told you earlier, I have a huge bunch of commits comming up which will break backwards compatibility.Can you please delay committing your changes?
Apologies -- I've put in a couple of commits already. First is a tiny change limited to bin/pdoc, and the other is a pretty minor change to the website generator.
Has anybody pulled these? If not I'll roll them back out of master.
James Coglan
Jan 7, 2010, 5:56:57 PM1/7/10
to pd...@googlegroups.com
2010/1/7 James Coglan <jco...@googlemail.com>
Actually I've just moved the final one into it's own branch:
http://github.com/tobie/pdoc/tree/section_children
The bin/pdoc bug fix is still in master, I'd be surprised it causes merge conflicts.
Reply all
Reply to author
Forward
0 new messages