I wanted to list all core images so I wrote

<<list-links "[prefix[$:/core/images]]">>

I saw nothing - Am I going nuts? this worked

<<list-links "[prefix[How]]">>

This did what I expected - what does the "documentation" say
(by that mean https://tiddlywiki.com/#list-links%20Macro%20(Examples))
(I assume this is the definitive version)

   This example lists all the tiddlers whose titles start with J:
   <<list-links filter:"[prefix[J]]">>

Applying the principle of least astonishment then

   <<list-links "[prefix[$:/core/images]]">>

Should list all tiddlers whose title starts $:/code/images - but it does not



Given that the code (ie the observed behaviour) and documentation differ
I do not know if

    a) the code is correct and the documentation is in error - so I report 
an error in the
        documentation

    b) the documentation is correct and the code is wrong so I report an 
error in the code

Since documentation is easier to read than code (which is why we write it) 
I strongly
believe that the code should document what the code is supposed to do and 
NOT
what the code actually does - and then people can report errors in the code 
when they find them.

At the moment when code and documentation differ nobody knows which is 
correct and
an ad hock decision is made as to which is correct.

As an aside I'd like to add that this is not a new problem - when we 
developed Erlang the code
and development was always out of phase.

When I wrote [shamless 
plug] https://pragprog.com/book/jaerlang2/programming-erlang
I decided to describe exactly what the system should do even if this was 
not what the system
actually did. I said that the book was definitive and if the code in the 
delivered system behaved in
a different manner to the book then file a bug report since the code was 
incorrect.

In a new system, the code will always be further advanced than 
documentation since we don't yet know 
what the system should do.

In a mature system, we should now know what the system should do so the 
documentation should be definitive and not the code.

Tiddlywiki is mature - so maybe we should concentrate on definitive correct 
documentation and describe what the system is supposed to do and not what 
it actually does.

Cheers

/Joe




-- 
You received this message because you are subscribed to the Google Groups 
"TiddlyWikiDev" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/tiddlywikidev.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/tiddlywikidev/94151e99-911f-4b53-b52f-3e620d0ebb9d%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to