Title: Incorrect documentation
Last modified: August 21, 2016

---

# Incorrect documentation

 *  Resolved [dan_ctow](https://wordpress.org/support/users/dan_ctow/)
 * (@dan_ctow)
 * [11 years, 11 months ago](https://wordpress.org/support/topic/incorrect-documentation/)
 * Your documentation is full of mistakes. Latest one I found was at [http://docs.getshopped.org/documentation/wpsc_end_category_query/](http://docs.getshopped.org/documentation/wpsc_end_category_query/)
 * In this case, you state **wpsc_end_category_query()** is in **category.functions.
   php**. It is not. After near 2 hours, I found it in **/wp-content/plugins/wp-
   e-commerce/wpsc-components/theme-engine-v1/helpers/product.php**
 * You have made it abundantly clear on your website that you don’t care to be contacted
   unless we pay you. So, I have no choice but to publicly ask you to sift through
   the outdated and wrong info on your documentation.
 * Thank you.
 * [https://wordpress.org/plugins/wp-e-commerce/](https://wordpress.org/plugins/wp-e-commerce/)

Viewing 6 replies - 1 through 6 (of 6 total)

 *  [whitelamp](https://wordpress.org/support/users/whitelamp/)
 * (@whitelamp)
 * [11 years, 11 months ago](https://wordpress.org/support/topic/incorrect-documentation/#post-5028040)
 * Just a thought, who is going to pay them to sift through the documentation and
   correct it?
 * In any case, for future reference, it should not take two hours to find a function.
   Ten seconds is more like it. On my platform I use “ack-grep”: [http://beyondgrep.com/install/](http://beyondgrep.com/install/).
 * Alternatively if you have a decent text editor like “sublime” you’ll find it 
   has a “find in files” function that will search a directory, list where it finds
   it, rather brilliantly seems to put the function defnition first in the list,
   and with one click takes you to it.
 * [http://www.sublimetext.com/2](http://www.sublimetext.com/2)
 *  Plugin Author [Justin Sainton](https://wordpress.org/support/users/justinsainton/)
 * (@justinsainton)
 * [11 years, 11 months ago](https://wordpress.org/support/topic/incorrect-documentation/#post-5028055)
 * Thanks for the vote of confidence, whitelamp! You hit on something really spot-
   on for us – we’re a small team of quite limited resources, with much of the time
   contributed to the open source project done as a matter of contribution, not 
   a matter of payroll. Documentation, beyond internal doc blocks, is certainly 
   an area that gets booted to the bottom of the list, for better or worse. And 
   your advice is spot-on, developers using any software project will always actually
   be best served by searching the core docs.
 * That said – dan_ctow, I totally get your frustration here. While I disagree with
   the sentiment that we don’t care to be contacted unless we’re paid for it (you’ll
   see us respond here quite often, in fact) – we certainly have room for improvement
   on our documentation.
 * If you have anything, as a developer, that you think would be helpful – we’re
   totally open for feedback! We’re in the middle of discussions, actually, on how
   we might make our docs site much more useful for people like yourself. Any real
   feedback you have would be invaluable.
 *  [whitelamp](https://wordpress.org/support/users/whitelamp/)
 * (@whitelamp)
 * [11 years, 11 months ago](https://wordpress.org/support/topic/incorrect-documentation/#post-5028112)
 * Justin, you’re welcome.
 * As for documentation and support – I found the old forum system preferable as
   it allowed me to concentrate my efforts on my niche areas (payment systems, back-
   end code) and ignore the questions about e.g. presentation and theming. But that’s
   by the by.
 * Have you considered a wiki?
 *  Plugin Author [Justin Sainton](https://wordpress.org/support/users/justinsainton/)
 * (@justinsainton)
 * [11 years, 11 months ago](https://wordpress.org/support/topic/incorrect-documentation/#post-5028113)
 * Great question. We’re considering lots of options, actually.
 * One thing I’d actually love is a site that had a starting foundation of automated
   documentation reference (not unlike [http://developer.wordpress.org/reference](http://developer.wordpress.org/reference)).
   And then, on top of that, we could add and relate tutorials and examples to each
   filter/class, etc.
 * Another option is something slightly closer to what we have now on the docs site,
   but using a different/better theme, [like this](http://tareq.wedevs.com/2014/01/wedocs-a-free-documentation-theme-for-wordpress/)–
   but keeping it up to date.
 * Part of the wiki concept that we’d be dealing with is kind of the same issue 
   you see in the Codex – ensuring quality and best practices. That’s one of the
   reasons we haven’t been super sold on it yet.
 * Would welcome any thoughts you have on the matter!
 *  Thread Starter [dan_ctow](https://wordpress.org/support/users/dan_ctow/)
 * (@dan_ctow)
 * [11 years, 11 months ago](https://wordpress.org/support/topic/incorrect-documentation/#post-5028188)
 * Hi
 * Maybe I was a little harsh and I apoligise for that however it is quite frustrating
   when you cannot get hold of a developer beacuse they appear to make the effort
   to conceal contact details on their websites (aside from your “Premium Support”),
   I was actually quite surprised that you replied so soon as this is often not 
   the case.
 * Anyway, providing no documentation at all is better than bad documentation and
   alongside Whitelamp, I would suggest something like a Wiki. I can’t imagine that
   there would be too many bad contributions to it however, you are right. You will
   need to but a small amount of time into quality control.
 * Anything I can do to help?
 * Dan
 *  [Edward](https://wordpress.org/support/users/edwardinstinct/)
 * (@edwardinstinct)
 * [11 years, 11 months ago](https://wordpress.org/support/topic/incorrect-documentation/#post-5028193)
 * Thank you for the feedback. We hear you honest we do. We are very aware our docs
   site is outdated at best. Justin has brought up several great points as why we
   have not moved in any one direction yet. Rather than waste more time starting
   with something that doesn’t work and having to shift again we are in somewhat
   of a holding pattern with it.
 * The major issue of anything open such as a forum or wiki is quality and spam 
   control. Spam became a monstrous problem with our old forums and docs site. Fake
   users would sign up and then post spam.
 * Please understand we most definetly are looking to resolve many things we consider
   long overdue.
 * We always appreciate feedback and thank you for your understanding.
 * Regards
    Edward

Viewing 6 replies - 1 through 6 (of 6 total)

The topic ‘Incorrect documentation’ is closed to new replies.

 * ![](https://s.w.org/plugins/geopattern-icon/wp-e-commerce_ebebeb.svg)
 * [WP eCommerce](https://wordpress.org/plugins/wp-e-commerce/)
 * [Frequently Asked Questions](https://wordpress.org/plugins/wp-e-commerce/#faq)
 * [Support Threads](https://wordpress.org/support/plugin/wp-e-commerce/)
 * [Active Topics](https://wordpress.org/support/plugin/wp-e-commerce/active/)
 * [Unresolved Topics](https://wordpress.org/support/plugin/wp-e-commerce/unresolved/)
 * [Reviews](https://wordpress.org/support/plugin/wp-e-commerce/reviews/)

## Tags

 * [bad documentation](https://wordpress.org/support/topic-tag/bad-documentation/)
 * [wp ecommerce](https://wordpress.org/support/topic-tag/wp-ecommerce/)

 * 6 replies
 * 4 participants
 * Last reply from: [Edward](https://wordpress.org/support/users/edwardinstinct/)
 * Last activity: [11 years, 11 months ago](https://wordpress.org/support/topic/incorrect-documentation/#post-5028193)
 * Status: resolved