Skip to content
This repository was archived by the owner on Mar 3, 2023. It is now read-only.

Describe key optionality property of maps on the README.#14

Merged
Hrubon merged 3 commits intomasterfrom
13-map-readme
Nov 2, 2021
Merged

Describe key optionality property of maps on the README.#14
Hrubon merged 3 commits intomasterfrom
13-map-readme

Conversation

@jan-dubsky
Copy link
Contributor

Closes #13

@jan-dubsky jan-dubsky requested a review from Hrubon October 29, 2021 12:32
Copy link
Collaborator

@Hrubon Hrubon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice elaboration. But I am not sure whether it is desirable to have such elaboration present on "homepage" of the project. I would be for keeping the homepage as concise and readable as possible. This nicely explains the motivation and design choices, but it goes into detail just too much, in my opinion.

I would suggest putting this to the end of the GitHub issue as a conclusion. Or at least put it on a separate README page (not sure whether and how actually GitHub supports that). And write a short paragraph at the end of the Parsing maps section on homepage, stating just something like: "Beware of maps, they are implicitly optional. See this GitHub issue (or this page) for more details, reasons, and discussion."

Copy link
Collaborator

@Hrubon Hrubon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. I have also added a headline that will emphasize the short-summary in section about maps.

@Hrubon Hrubon merged commit 2539fb8 into master Nov 2, 2021
@Hrubon Hrubon deleted the 13-map-readme branch November 2, 2021 16:23
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

map with no values does not return error

2 participants