hal-forms icon indicating copy to clipboard operation
hal-forms copied to clipboard

Typos in type definition

Open Ickbinet opened this issue 4 years ago • 6 comments

https://rwcbook.github.io/hal-forms/#_code_type_code

"Possible settings for the type value adn teh expected contents to be returned inthe are:"

Should be?:

"Possible settings for the type value and the expected contents to be returned in here are:"

Ickbinet avatar Nov 01 '21 11:11 Ickbinet

It might also be a good chance to add a note on whether the list of possible values for type is exhaustive. That list is very close to HTML input types except checkbox, radio and file. Are other types generally supported, too?

odrotbohm avatar Nov 01 '21 15:11 odrotbohm

update got reverted somehow. will fix

and, yes, we should state that "type" list is not exclusive. with a fallback for when client's don't recognize the value of "type"

mamund avatar Nov 01 '21 15:11 mamund

Should we remove the sentence about type being an "enumerated attribute"? It's that one, that led me to assume exhaustiveness of the list given. Because, if arbitrary other types are allowed as well, there's no enumeration anymore, is there?

odrotbohm avatar Nov 01 '21 15:11 odrotbohm

removing would be OK w/ me. AFAIK, the word's definition does not call for exhastiveness. but happy to improve clarity here.

mamund avatar Nov 01 '21 15:11 mamund

As we're following concepts of HTML pretty closely I had assumed it was a reference to the concept of an enumerated attribute like this: https://stackoverflow.com/questions/4104110/what-are-enumerated-attributes-in-html

odrotbohm avatar Nov 01 '21 16:11 odrotbohm

that's a very reasonable assumption. i agree that we should drop "enumerated". it's a small change for a big win.

mamund avatar Nov 01 '21 16:11 mamund