Some suggestions for documentation
Brought to you by:
bs_php,
nigelswinson
From: Peter R. <php...@pe...> - 2002-05-15 17:20:09
|
1. It's useful that the intro defines things like absolutexpath and xpathquery, but the function list doesn't use these consistently, using other terms like xpath expression or xpath string. I feel this is likely to confuse newbies. 2. an example of evaluate/match in the sample code, and when it would be used. Am I right in thinking this is the only function that uses an xpathquery, i.e. that works with a node set and not an absolute address? This was something I misunderstood when I first used the class, as I thought you always had to do an evaluate before using any of the other functions. If you only want one node, don't use evaluate, as it just slows things down. 3. it would be helpful if the functions were grouped together more, e.g. if getNode and getNodePath were together. In fact, a list of functions by category would be useful, so that, for example, wholeText appears with the other content retrieval functions, and it's explained how they differ. 4. equalNodes should read "compare two nodes" ! 5. perhaps worth stressing with decodeEntities that it uses PHP functions, limited to 8859-1. 6. I think you mean 'relational database' - it may also be rational :-) |