Re: [docs] [PATCH v2 1/4] migration/release-notes-5.1: document oeqa/selftest envvars change

[Antonin Godard <antonin.godard@bootlin.com>]

On 01/10/2024 12:20, Quentin Schulz wrote:
>> Thanks for your reviews, they also help. As for selftest, I haven't seen
>> it referenced with single-tick quotes elsewhere, unless you meant double
>> ticks for code?
>>
> 
> I think what we discussed at the time with Michael was basically that 
> anything that isn't an English word, or is but shouldn't be understood 
> as one in the context (e.g. truncate as in the tool and not the English 
> word) should be highlighted so that people don't confuse it with the 
> English word.
> 
> I think this is what we meant in the standards file here: 
> https://git.yoctoproject.org/yocto-docs/tree/documentation/standards.md#n79

Gotcha, single-quote it is indeed.

> Note that these were rules Michael/we came up with for new contributions 
> to the docs, because we knew updating everything to match the standards 
> would take a long time.
> 
> I still remember reading every page of the docs during the migration to 
> Sphinx and I am not ready to do this again any time soon :) So patching 
> when stumbling upon things that don't match the standard while reading 
> the docs and enforcing it for new contributions made sense at the time.
> 
> Anyway, that's process and standards, they need to make sense to the 
> maintainer and the community, and can evolve over time, so up to you, 
> just putting out there the history and "current" state of affairs :)
> 
> Since 5.1 is supposed to be out soonish, maybe something to be picky 
> about after the release is done ;) Up to you!

Thanks a lot for these details and historical decisions! I will keep 
that in mind. I am okay with being picky on this, as it improves the 
overall readability of the doc. I'm trying to do that in the release 
note I'm editing atm.

Cheers,
Antonin