The documentation for the "Charts" module's API is so out of date that the sample code calls functions that don't exist in the current revision, causing fatal errors.

Specifically:
Example #1 on this page: https://drupal.org/node/233916
...contains fatally out of date code.

quicksketch provided example code that's compatible with the current module here: https://drupal.org/node/2218941

I'd propose that the docs substitute that code for the current example #1. Also, that they be given a further looking over by someone who already understands the Charts Module, unlike me, who is learning it right now. :)

Comments

LeeHunter’s picture

Component: Correction/Clarification » API documentation files
LeeHunter’s picture

Component: API documentation files » Correction/Clarification

Oops. Changing the component tag again.

jhodgdon’s picture

Project: Documentation » Charts
Version: » 7.x-2.x-dev
Component: Correction/Clarification » Documentation

Let's move this into the Charts module issue queue.

Pierre.Vriens’s picture

For some reason this reminds me about "George" that Dries was talking about in his keynote from DrupalCon Amsterdam 2014 ... Don't get me wrong: I like people doing an effort to report about such documentation issue, but why not just go ahead and at least edit that docu by adding the reference pointing to a correct example there?

Also, for somebody who wants to learn about a module, I think working on documentation (contributing to it) is a great way to actually learn about it. It's what I experienced while working on docu contributions for module Forena Reports & Charts, which in certain situations might be considered as an alternative and/or a complement to the chart module. For details about these contributions, checkout #2124777: HELP reports reorganization and #2355193: Extend community docu.

Pierre.Vriens’s picture

Pierre.Vriens’s picture

Category: Bug report » Task
Pierre.Vriens’s picture

Title: Charts Project documentation is an entire revision out of date. » Enhance Charts documentation

Updating the issue title to simplify tracking of other documentation related issues.

Pierre.Vriens’s picture

I've started some work related to this issue, more specifically the community docu. Updated the page status of various pages, added some D7 related remarks, did some rewording, etc (check it out for more details). Not a lot of progress so far (there is a lot to be completed ... and missing). Anybody interested in helping with / contributing to it?

Pierre.Vriens’s picture

Status: Active » Needs work
Issue tags: +Novice

I made quite some progress (I think) regarding the community docu. Are there at least some more sites (except from the 1 comment somewhere last week), out of all those +9K sites using the charts module these days, that might be willing to at least start reviewing some of it, and provide some type of feedback? Like if it is evolving in the right direction?

Attention: this is still a work in progress, and I fear that there is still a looooooooong way to go. One never realises what HAS BEEN done, only what REMAINS TO BE done ... That's why I'm changing the issue status now, and add some tag that might help for others to step in and help contributing to it also ...

@baudot: would you mind editing the initial issue description, or add a new comment containing an updated status of it? So that it matches your current perception of the current status of the charts docu (because the original issue is "so out of date" ...).