Re: [Docutils-users] [SPAM] Re: Atom Syndication Format minimal example.

[Guenter M. <mi...@us...>]

Dear Schimon,

thanks for the new example.

On 2025-10-10, Schimon Jehudah via Docutils-users wrote:
> On Thu, 9 Oct 2025 17:22:42 -0000 (UTC)
> Guenter Milde via Docutils-users <doc...@li...>
> wrote:

>> I just want a `minimal working example` as (opposed to illustrative
>> examples):

>>   The important feature of a minimal reproducible example is that it
>>   is as small and as simple as possible, such that it is just
>>   sufficient to demonstrate the problem, [...]
>>   -- https://en.wikipedia.org/wiki/Minimal_reproducible_example

...

> Are the attached files qualified as a proper example, or should I
> create a reduced version of the code that realizes that task?

Is getting close, but I would still call it an "illustrative example"
or "use case".  A "minimal example" could be even smaller.

For example, the content could be just two small paragraphs.
(However, it should keep containing at least one element that
distinguishes reStructuredText from plain text or other markup.)

Generally, a "minimal working example" would also include a description
of the steps to get the result.  
However, currently I will not try to reproduce the results, so this is
not required here. 

Günter


> [-- Type: text/x-rst, Encoding: 7bit, Filename: rst.rst --]

> .. authors: Schimon Jehudah Zachary , xmpp:sc...@pi...?message
> .. date: 2025-07-14 00:00:00 UTC
> .. description: A markup syntax.
> .. link: rst
> .. related:
>    reStructuredText homesite , https://docutils.sourceforge.io/rst.html
>    reStructuredText tutorials , https://docutils.sourceforge.io/docs/ref/rst/
> .. slug: rst
> .. tags:
>    Documentation, Publishing, Python Computer language, reStructuredText, rST
> .. title: reStructuredText
> .. type: text

> reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext
> markup syntax and parser system. It is useful for in-line program documentation
> (such as Python docstrings), for quickly creating simple internet pages, and for
> standalone documents.

...

> .. epigraph::
>    "reStructuredText" is ONE word, not two!