YETUS-1099. shelldocs --lint option fails

[aajisaka]

JIRA: https://issues.apache.org/jira/browse/YETUS-1099

[aw-was-here]

'Yes' and 'No' are not documented as being valid.

[aajisaka]

yetus/shelldocs/src/main/python/shelldocs.py

Lines 174 to 178 in 227c762

	def getreplace(self):
	'''get the replacement state'''
	if self.replaceb:
	return "Yes"
	return "No"

Here self.getreplace returns "Yes" or "No", therefore I changed the valid values correspondingly to pass the elif statement below:

yetus/shelldocs/src/main/python/shelldocs.py

Lines 278 to 283 in 227c762

	elif value not in validvalues[attr]:
	validvalue = "|".join(v.lower() for v in validvalues[attr])
	messages.append(
	"%s:%u: ERROR: function %s has invalid value (%s) for @%s (%s)"
	% (self.getfilename(), self.getlinenum(), self.getname(),
	value.lower(), attr.lower(), validvalue))

Should I update self.getreplace to return "yes/no" instead of "Yes/No"?

[aajisaka]

Rethinking this, just adding a function to get the raw replaceable text is fine.

[aw-was-here]

The point of YETUS-1089 was to better enforce the ruleset and provide valid output. 'yes' or 'no' are the values that are considered valid. A value of 'Yes' or 'No' would be considered invalid and they should throw an error. Checking the validity of the rendered output rather than the parsed value doesn't do that.

[aajisaka]

Thank you @aw-was-here for the detail. I've updated the patch to check the parsed value. 0e3b97a

[aajisaka]

yetus/shelldocs/src/main/python/shelldocs.py

Line 283 in 227c762

value.lower(), attr.lower(), validvalue))

You said the validity check should be case-sensitive, so I thought value.lower() should be value in the error message. What do you think?

[aajisaka]

I thought value.lower() should be value in the error message.

Umm. It is not good for other attrs because the validity check of the attrs looks case-insensitive.

[aajisaka]

@aw-was-here Would you check the latest commit? I think now it validates the parsed value.

[aajisaka]

I'll merge tomorrow if there are no objections.

[aw-was-here]

Yeah, this might work. Might as well commit it and we'll deal with it later if it doesn't. (There are a ton of other bugs in 0.13 that are probably more visible soooo)

[aajisaka]

Thank you @aw-was-here and @busbey