Just to say that I agree that the widget documentation could do with improvement. It’s worth making a distinction between two different kinds of improvement:
* Documentation for individual widgets that need clarification or more examples, such as the examples Mohammad gave. These sort of improvements can often be a PR to a single file, a workflow that we’ve worked hard to optimise * Improving the standard conventions/macros/formatting that is used for all widgets. For example, I really like Stobot’s suggestion for improving the presentation of widget syntax The catch is that those improvements in the second category need to be applied consistently to all the existing widgets, which is a much bigger undertaking. However, the benefit is immense, and so I’d encourage anyone who is interested to volunteer; you can expect plenty of help and support. Best wishes Jeremy. > On 25 May 2021, at 17:19, Mohammad Rahmani <[email protected]> wrote: > > Hi Mario, > > Ah, I did not know that! Is there any reason for that? (missing purpose and > parameter in https://tiddlywiki.com/prerelease > <https://tiddlywiki.com/prerelease>) > > > > On Tue, May 25, 2021 at 8:10 PM PMario <[email protected] > <mailto:[email protected]>> wrote: > The "operator" docs is a formal description. ... The (Examples) should be for > the "understanding". ... The problem is, we do need more "real world" > examples, + explanation. That's all. > > I think everyone is free to provide "pull requests" at GitHub, or post > examples in the GG, that can be transferred to the docs. > > That is true! Maybe the proposal by stobot above works here to have more > clear docs for newcomers! > > > PRs are preferred, since it makes live much easier for developers. > > just my thougths > mario > > > Thank you! > > > > -- > You received this message because you are subscribed to the Google Groups > "TiddlyWiki" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected] > <mailto:[email protected]>. > To view this discussion on the web visit > https://groups.google.com/d/msgid/tiddlywiki/c463570c-fd8f-4a6e-a13a-9f1cbe0f8ba2n%40googlegroups.com > > <https://groups.google.com/d/msgid/tiddlywiki/c463570c-fd8f-4a6e-a13a-9f1cbe0f8ba2n%40googlegroups.com?utm_medium=email&utm_source=footer>. > > -- > You received this message because you are subscribed to the Google Groups > "TiddlyWiki" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected] > <mailto:[email protected]>. > To view this discussion on the web visit > https://groups.google.com/d/msgid/tiddlywiki/CAAV1gMAdPsZ8C-p0XsZ7gNqZezTM1dw_CVYsYE1xodpFan%3Dc%2BA%40mail.gmail.com > > <https://groups.google.com/d/msgid/tiddlywiki/CAAV1gMAdPsZ8C-p0XsZ7gNqZezTM1dw_CVYsYE1xodpFan%3Dc%2BA%40mail.gmail.com?utm_medium=email&utm_source=footer>. -- You received this message because you are subscribed to the Google Groups "TiddlyWiki" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywiki/9061BDD0-6705-4135-8A27-500587D169D7%40gmail.com.
