Module talk:Yesno

From WikiProjectMed
(Redirected from Module talk:Yesno/doc)
Jump to navigation Jump to search

Testcases and documentation

{| class="wikitable"
|+ Test Cases (via [[Template:Yesno/doc]])
|-
! Module output
! Template output
! Expected
|-
| {{#invoke:Yesno|yesno|yes}}
| {{yesno|yes}}
| yes
|-
| {{#invoke:Yesno|yesno|YeS}}
| {{yesno|YeS}}
| yes
|-
| {{#invoke:Yesno|yesno|Y}}
| {{yesno|Y}}
| yes
|-
| {{#invoke:Yesno|yesno|y}}
| {{yesno|y}}
| yes
|-
| {{#invoke:Yesno|yesno|no}}
| {{yesno|no}}
| ''(blank)''
|-
| {{#invoke:Yesno|yesno|}}
| {{yesno|}}
| ''(blank)''
|-
| {{#invoke:Yesno|yesno}}
| {{yesno}}
| ''(blank)''
|-
| {{#invoke:Yesno|yesno|¬}}
| {{yesno|¬}}
| ''(blank)''
|-
| {{#invoke:Yesno|yesno|purplemonkeydishwasher}}
| {{yesno|purplemonkeydishwasher}}
| yes
|-
| {{#invoke:Yesno|yesno|yes|yes=bacon}}
| {{yesno|yes|yes=bacon}}
| bacon
|-
| {{#invoke:Yesno|yesno|no|no=ham}}
| {{yesno|no|no=ham}}
| ham
|-
| {{#invoke:Yesno|yesno|blank= eggs}}
| {{yesno|blank= eggs}}
| 
|-
| {{#invoke:Yesno|yesno|no=ham}}
| {{yesno|no=ham}}
| 
|-
| {{#invoke:Yesno|yesno|blank= eggs|no=ham}}
| {{yesno|blank= eggs|no=ham}}
| 
|-
| {{#invoke:Yesno|yesno|¬|¬=sausage}}
| {{yesno|¬|¬=sausage}}
| sausage
|-
| {{#invoke:Yesno|yesno|purplemonkeydishwasher|def=cup-of-tea}}
| {{yesno|purplemonkeydishwasher|def=cup-of-tea}}
| cup-of-tea
|-
| {{#invoke:Yesno|yesno|purplemonkeydishwasher|yes=bacon}}
| {{yesno|purplemonkeydishwasher|yes=bacon}}
| bacon
|-
| {{#invoke:Yesno|yesno|purplemonkeydishwasher|def=cup-of-tea|yes=bacon}}
| {{yesno|purplemonkeydishwasher|def=cup-of-tea|yes=bacon}}
| cup-of-tea
|-
| {{#invoke:Yesno|yesno|yes|yes=no|no=yes}}
| {{yesno|yes|yes=no|no=yes}}
| no
|-
| {{#invoke:Yesno|yesno|no|yes=no|no=yes}}
| {{yesno|no|yes=no|no=yes}}
| yes
|-
| {{#invoke:Yesno|yesno| no |no=no}}
| {{yesno| no |no=no}}
| no
|}
Note: Pre tags added to suppress script errors. — Mr. Stradivarius ♪ talk ♪ 14:25, 20 September 2013 (UTC)[reply]

As you can see, the template does not behave exactly as its documentation claims it does. I was not sure which to regard as authoritative: the ideal or actual implementation. I ultimately went with the former. Removing and not any from the Lua code will make the module behave like exactly like the template.

--Ori.livneh (talk) 10:46, 28 February 2013 (UTC)[reply]

Just needs to handle spaces in the params better. -- WOSlinker (talk) 11:41, 2 March 2013 (UTC)[reply]
Thanks. Fixed. I moved your test case to the table above. --Ori.livneh (talk) 05:58, 3 March 2013 (UTC)[reply]
Yesno has ~8M transclusions. No question it should handle the legacy 1:1. Test it. -DePiep (talk) 22:31, 11 March 2013 (UTC)[reply]

The documentation is wrong. The "egg" example assumes thet the input value is blank. But in the code examples the input parameter is omitted. Compare:

  • {{yesno|blank= eggs|no=ham}} →
  • {{yesno||blank= eggs|no=ham}} → eggs

This is what is actually documented:

  • {{yesno|blank= eggs|no=ham|¬=bread}} → bread
I have changed the documentation. Not the table above. -DePiep (talk) 13:16, 23 March 2013 (UTC)[reply]

Why?

{{yesno}} is quite simple, so I'm not sure if there is a point in replacing it with functionally equivalent Lua. There are many cases where Lua can be much faster and easier to read, but I'm not sure that is the case here. In fact, because of the slight overhead with #invoke, simple parser functions can actually be slightly faster than the equivalent Lua. I haven't tested that here, but I wouldn't be surprised if there is no performance advantage in a case like this. Seems like a strange template to target for Lua conversion. Dragons flight (talk) 14:57, 12 March 2013 (UTC)[reply]

It’s just for compatibility. For some weird reason, yesno might not work and this will.

E Super Maker (😲 shout) 15:47, 23 November 2019 (UTC)[reply]

test failed

Resolved

One fail found in unit test: value "1= ¬ " (with whitespace). Reason:whitespace not removed before this check. Possible solution; treat '¬' as a character, separate from nil. (if val == nil or val == '¬' then ...). -DePiep (talk) 11:54, 23 March 2013 (UTC)[reply]

also fails when 1=0.0
Suggestion: change val = args[1] into val = tostring(args[1]). To prevent treating "000" as number. -DePiep (talk) 14:09, 23 March 2013 (UTC)[reply]

Solved. Module is changed, although the numeric issue different from my (incorrect) suggestion. -DePiep (talk) 14:19, 23 March 2013 (UTC)[reply]

Thanks for putting the test cases up. I learned something new about ParserFunctions. :) Still seems to be slower than the old template version though. — Mr. Stradivarius ♪ talk ♪ 14:38, 23 March 2013 (UTC)[reply]

Null?

The code now says no = "<!-- null -->". But a "" (nullstring) is not the same as ASCII NULL (0x0000). Also I see no use for adding wiki comment to code this way. -DePiep (talk) 17:47, 23 March 2013 (UTC)[reply]

Yes, I agree that it doesn't really make sense. It's just in there to be 100% backwards-compatible with the current template. Those html comments should really have been removed from {{yesno}} when it was made subst-able, which would have prevented us from having to second-guess whether they actually affect the output of any substitutions in any meaningful way. I suppose it's possible to download a database dump and to run a search on it to find out, but that's probably a bit much for my poor ailing laptop. Or we could just remove the comments and hope nothing breaks - I'm fairly sure that no-one would have written any template code that purposefully used them. There's no way to be sure that there is no code that was inadvertently written to be dependent on the error, though, and that worries me. — Mr. Stradivarius ♪ talk ♪ 18:24, 23 March 2013 (UTC)[reply]
Drop it. Come what may. -DePiep (talk) 00:17, 24 March 2013 (UTC)[reply]

Rewrite

I've rewritten this as a pure Lua function. The new version is a lot simpler, and is also designed to work with Lua data types such as booleans, tables, and functions. Dragons flight's criticism above is well-founded, and giving up on the idea of replacing {{yesno}} seemed like the best answer. The new version should hopefully retain the basics of {{yesno}} while playing well with Lua, and allow meta-modules that deal with boolean-style wikitext input to be consistent with each other. (In other words, users won't have to remember whether it was "category=yes" or "category=true" - it should Just WorkTM.) — Mr. Stradivarius ♪ talk ♪ 14:37, 20 September 2013 (UTC)[reply]

All testcases failed

is there some issue with the module, all tests on the Module talk:Yesno/testcases has failed. --Jarekt (talk) 16:37, 20 December 2013 (UTC)[reply]

Protected edit request on 24 February 2014

the information is deceptive

please delete 2600:1013:B018:986F:4493:7A2A:52E2:103A (talk) 04:21, 24 February 2014 (UTC)[reply]

Not done: please be more specific about what needs to be changed. Note that this is the talk page for Module:Yesno and there is no information here. What information on which page do you think is deceptive? — {{U|Technical 13}} (tec) 04:27, 24 February 2014 (UTC)[reply]

New version

I've put a new version of this module in the sandbox. The new version uses the native Lua string.lower function instead of the Scribunto mw.ustring.lower function. According to my tests it is about 25x faster this way. Would anyone object to me updating the module? — Mr. Stradivarius ♪ talk ♪ 15:22, 7 April 2014 (UTC)[reply]

I see no issue with it. Jackmcbarn (talk) 18:57, 7 April 2014 (UTC)[reply]
The new version is live as of the 18th. — Mr. Stradivarius ♪ talk ♪ 12:33, 22 April 2014 (UTC)[reply]

Doc questions (blank string true/false)

  1. In the documentation, I changed the "nil" example into singular. Or are there are other forms of nil covered and to be documented? (uppercase?, a non-initialised variable?).
  2. The last paragraph is about the '' value (blank string). It says:
Although the blank string usually evaluates to false in wikitext, it evaluates to true in Lua. Is this correct here?
According to this same documentation, it is treated as "not a boolean". It says it returns the default (parameter) value, not the 'true' value. That is: not recognised as a boolean, iic. And elsewhere the doc says "yesno('') returns nil". (I did not test any). -DePiep (talk) 09:06, 8 April 2014 (UTC)[reply]
On nil: there is only one kind of nil. However, there may be many variables in any given module whose value may be nil, hence "nil values". There is no "uppercase nil", and in Lua there is no such thing as a non-initialised variable, as variables are initialised when they are first used. On the blank string: saying that it "evaluates to true" is talking about when it is used in if/then statements or with the and and or operators. For example, the following code will return true:
if '' then
	return true
else
	return false
end
Does that clear things up? — Mr. Stradivarius ♪ talk ♪ 09:26, 8 April 2014 (UTC)[reply]
Does it clear things up? Don't know. Documentation did not change. -DePiep (talk) 12:10, 8 April 2014 (UTC)[reply]
I mean, do you understand it now? — Mr. Stradivarius ♪ talk ♪ 12:34, 8 April 2014 (UTC)[reply]

Render T as true as well?

I have seen some applications use T as an option for true as well. It might, therefore, be useful to have the letter T (t) represent a true value as well. CRwikiCA talk 15:15, 14 April 2015 (UTC)[reply]

Request

I request a change to the module to recognize T or t and F or f as true and false entries. This would make the full code the following:

-- Function allowing for consistent treatment of boolean-like wikitext input.
-- It works similarly to the template {{yesno}}.

return function (val, default)
	-- If your wiki uses non-ascii characters for any of "yes", "no", etc., you
	-- should replace "val:lower()" with "mw.ustring.lower(val)" in the
	-- following line.
	val = type(val) == 'string' and val:lower() or val
	if val == nil then
		return nil
	elseif val == true 
		or val == 'yes'
		or val == 'y'
		or val == 'true'
		or val == 't'
		or tonumber(val) == 1
	then
		return true
	elseif val == false
		or val == 'no'
		or val == 'n'
		or val == 'false'
		or val == 'f'
		or tonumber(val) == 0
	then
		return false
	else
		return default
	end
end

Where lines 15 and 23 are new compared to the current code. CRwikiCA talk 18:17, 23 April 2015 (UTC)[reply]

No opposition, so  Done — Martin (MSGJ · talk) 10:43, 27 April 2015 (UTC)[reply]

Support on/off detection

Please add support for on and off values (as equivalents of 1 and 0, respectively), for consistency with the regular-template version {{Yesno}}, per RfC at Template talk:Yesno#Support on/off detection.  — SMcCandlish ¢ 😼  23:44, 22 February 2018 (UTC)[reply]

Very simple change, but i've sandboxed the change and ran the testcases.. Galobtter (pingó mió) 07:52, 25 February 2018 (UTC)[reply]
 Done — Martin (MSGJ · talk) 12:14, 28 February 2018 (UTC)[reply]
Thank you Galobtter, for the coding work (Lua gives me a headache), and MSGJ, for just getting it implemented, instead of either of you being a thorn in the side about it like several parties were for no defensible reason at the RfC. I've never encountered so much "resist sensible change just because I feel like it" nonsense on a minor technical matter as I did in this particular case. It was weird, verging on inexplicable.  — SMcCandlish ¢ 😼  18:37, 26 May 2018 (UTC)[reply]

Upgrade of protection level

I believe we should make this template editor protected (I've seen templates with way less of the amount of transclusions than this one being template protected). Just a suggestion before I would put it up in the list. KylieInTheSkylie (talk) 02:23, 6 April 2020 (UTC)[reply]

Just realized that full protection is not Extended confirmed protection. Please disregard this. KylieInTheSkylie (talk) 02:23, 6 April 2020 (UTC)[reply]

Multilingual version?

What about a multilingual version? Would there be any conflicts? Trigenibinion (talk) 17:21, 12 March 2021 (UTC)[reply]

It seems this is normally called the same in other languages, where they appear to tend to support English as well as the translation, so this should be usable in a multilingual module. Trigenibinion (talk) 17:57, 12 March 2021 (UTC)[reply]
There is no need for a multilingual version of this module to exist on this wiki, since its content is in only one language. Furthermore, were one created, it would be a recreation of Module:YesnoTNT, which was deleted per Wikipedia:Templates for discussion/Log/2019 December 11#Module:YesnoTNT, and I would move for it to be speedy deleted per WP:CSD#G4 * Pppery * it has begun... 20:36, 13 March 2021 (UTC)[reply]

Option: Binary-only?

I want to "propose" to add an option (feature) that makes the module return T/F only, never nil. For example, it could have para |whennil=<True or False>.

The background is that there are many situations (I meet in programming Lua) where a 'nil' return value is not helpful and still has to be handled separately into binary logic.

But even better, maybe I can learn why this was not added from the start, or why it could be considered bad design/coding. Maybe it could be solved by creating a wrapper like "Module:YesnoNevernil", or is that bad design again? -DePiep (talk) 04:56, 23 December 2021 (UTC)[reply]

It's easy enough to just handle the nil in your own code, for example: myvariable = yesno(value) or false -- WOSlinker (talk) 20:09, 23 December 2021 (UTC)[reply]
This can also mostly be handled by specifying the default parameter (i.e. myvariable = yesno(value, false)), although this does leave the case yesno(nil, false), which evaluates to nil. The reason I originally programmed the module this way is so that it can be mostly backwards-compatible with Template:Yesno, which it is intended to replace. Originally the plan was to do a straight conversion of Template:Yesno to Lua, but it turned out that doing that was actually slower than just using the template, given the template's simplicity and the initial cost of switching between PHP and Lua. So instead this module became Lua-only, with most of the behaviour of Template:Yesno. The intention there was that module writers could easily incorporate it into modules that convert more complex templates without having to change the template logic too much. — Mr. Stradivarius ♪ talk ♪ 22:11, 23 December 2021 (UTC)[reply]
OK, thx. I can use this code solution with confidence now, no research-&-test needed. Might as well add it to the /doc. -DePiep (talk) 16:35, 24 December 2021 (UTC)[reply]