Better documentation around named snippets

litghost commented 3 years ago

While debugging https://github.com/SymbiFlow/symbiflow-examples/pull/50, it is hard to follow the current strategy of naming tests by their order in a README. It also strikes me as fragile.

The README mentions a naming scheming, but doesn't provide a lot of context on how to use it.

Questions and requests:

How can snippets be named, so that invocation like https://github.com/SymbiFlow/symbiflow-examples/blob/master/.travis.yml#L28 can be clearer
Can we add some Travis tests to tuttest itself to both demostrating the naming features, and to insure they do not break?

mgielda commented 3 years ago

Sure! We'll get to it on Monday.

mgielda commented 3 years ago

In the meantime, IIRC it's the 'name' option in rst and a html comment in md that accomplishes this.

mgielda commented 3 years ago

@litghost hope this helps? The README describes it now.

mgielda commented 3 years ago

(please let us know if the explanation is enough for you and then we will close this)

antmicro / tuttest