did icon indicating copy to clipboard operation
did copied to clipboard

missing BFU docs

Open kavol opened this issue 9 years ago • 0 comments

Hi. It's nice to have the source code documented, but what I am really missing is some simple manual for newbies.

For example, I cannot find any explanation of the concept of section names - there are tons of example configs, but no single mention how do you choose the section names, or where are they used later.

Another example, I was interested what does this "prefix = BZ" option mean. It doesn't seem to be explained in the 'Config' chapter - instead it refers to 'Plugins' documentation. OK, so I went to Plugins/bugzilla and see this option repeated in config example snippet, but cannot find any single instance of 'prefix' within the explanatory text!

On the other hand, some other text, like "What did you do last week, month, year?" or "The config file ~/.did/config is used ..." is copied in multiple places.

Please, pretty please with sugar on top, take someone with zero knowledge of did and python, and write the manual from scratch while trying to teach the person how to use did ... do you really think that text like "class did.plugins.bugzilla.BugzillaStats(option, name=None, parent=None, user=None)" should be presented to users? Does your car manual list transponder chip model used in the remote while leaving out which button to press to open the car?

kavol avatar Jan 05 '16 11:01 kavol