Update README.md to explain how to compare enums (singleton limitation) #148
Conversation
README.md
Outdated
| @@ -65,6 +65,38 @@ function setAction(Action $action) { | |||
| } | |||
| ``` | |||
|
|
|||
| ## Comparison | |||
There was a problem hiding this comment.
It should come after the main documentation: it's a detail, it shouldn't distract from the existing documentation.
README.md
Outdated
| if ($action === Action::VIEW()) { | ||
| // ... | ||
| } | ||
| ``` |
There was a problem hiding this comment.
In my experience many people don't read paragraphs and copy/paste the first code block they find.
I'd rather start this section with "how to compare enums" (i.e. the code examples you have written below), and then explain that comparing enum instances with === doesn't work. No need to write more than a sentence or two TBH. No need to link to the issue either, nor use the word "workaround": this isn't really a bug, this is a minor detail that hasn't prevented this library to become the most widespread enum library in PHP.
|
@mnapoli I have updated the PR, let me know what you think |
|
Hi, I'm sorry but since July PHP 8.1 now have enums. I will be closing pull requests as we all migrate to the PHP 8.1 enums. |
|
@mnapoli Do you mean you will deprecate your package? Or you will upgrade this one to use native enums? |
|
(Sorry for the accidental reopen) This package is becoming obsolete with PHP 8.1. It will eventually be deprecated. There isn't anything this package will bring on top of PHP 8.1 enums. |
As per my earlier comment #8 (comment), I think it is worthwhile to mention in
README.mdthat php-enum are not singletons so when comparing them, strict comparison will not work as expected. @mnapoli Here is the PR as promised. Let me know what you think.