search

funkia / list

🐆 An immutable list with unmatched performance and a comprehensive functional API.
MIT License
1.65k stars 53 forks source link

Add documentaton for the isEmpty function in README.md #93

Closed renaultd closed 3 years ago

renaultd commented 3 years ago

The documentation inside README.md is missing for the isEmpty function. This seems particularly benign, but since I'd like to use the list package for a functional programming course, this becomes a bit more important.

This pull request only modifies the README.md file. It adds a documentation to the isEmpty function, in a simlar manner to the remainder of the file. It also makes a slight modification inside the documentation for the flatMap function, reusing the same style as the other functions in the documentation for the name aliases. This second modification should have been in its own commit, but I considered it is a one-liner inside a documentation file.

paldepind commented 3 years ago

Looks good. I must have missed isEmpty. Nice to get the alias for flapMap in line with the rest.

Thanks a lot and good luck with your course! Please share more information about the course and how you'll use List?