Archipelago icon indicating copy to clipboard operation
Archipelago copied to clipboard

Tests: allow for completely hidden options to not have docstrings

Open alwaysintreble opened this issue 1 year ago • 3 comments

What is this fixing or adding?

We have hidden options now, but unit tests still assert that they have docstrings even though said strings can never be user visible in certain cases, so this allows that.

How was this tested?

Removed a docstring from one of my options and ran the test with all the different visibility flags.

If this makes graphical changes, please attach screenshots.

alwaysintreble avatar May 03 '24 17:05 alwaysintreble

I feel like instead of allowing a missing docstring, it should still describe the option even when hidden. i.e. "Replaced by ...".

black-sliver avatar May 03 '24 18:05 black-sliver

Why?

Berserker66 avatar May 06 '24 07:05 Berserker66

Why?

It says why in the description. Being snarky doesn't help anyone.

alwaysintreble avatar May 07 '24 18:05 alwaysintreble

We still don't know what the actual use-case is. I still think a hidden option should either have a description, so we know what it's for, or have a text that says it was replaced. Either of which would be in doc string.

black-sliver avatar Jun 04 '24 15:06 black-sliver