| Index
» Projects
» phpMyEdit
» Forum
» Documentation |
 |
willirl
Joined: 04 Apr 2004
Posts: 14
Posted: 2004-04-05 23:16
Back to top
Reply with quote
|
Overall I think the documention is organized and presented well, I have two small complaints.
1. The basic fields are explained well enough because the concept is pretty simple. But the explanation of things like table joins and input limiting need a more complete example showing actual input and output.
2. The example code is confusing because it mixes metaphors. All through the code examples you see this:
| Code: |
$opts['fdd']['col_name']['values']['table']
|
Here it is not clear what is a keyword and what is to be substituted in the actual code. It would be clearer if it were shown something like this:
| Code: |
$opts['fdd']['<col_name>']['values']['table']
|
This at least gives a hint the col_name is not a keyword like 'fdd' and 'values' but is where you put in your table's column name. The underscore may have been intended to convey this but does not.
I think sometimes a new user can see things that aren't obvious to the authors.
|
nepto
Joined: 06 Jan 2003
Posts: 320
Location: Phoenix, Arizona (USA)
Posted: 2004-04-06 11:22
Back to top
Reply with quote
|
To use
['col_name']
it was Doug's idea and I liked it. I believe it is somewhere at the beginning of the field's options documentation written, that
['col_name']
should be substitued with actual column name.
However I agree, that in the example above if usage of
['colname']
quite confusing. I will consult this issue with Doug and we will try to improve it somehow.
Thank you for reporting.
_________________ Ondrej Jombik (Nepto)
Visit my
homepage
, review my recent
CV
or
projects
and give me some
feedback
.
|
|
Post new topic
Reply to topic
|
|
|
|