Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation on callmap editing #6409

Merged
merged 2 commits into from
Sep 4, 2021
Merged

Conversation

weirdan
Copy link
Collaborator

@weirdan weirdan commented Sep 4, 2021

No description provided.


Delta files (named `CallMap_<PHP major version><PHP minor version>_delta.php`)
list the changed that happened in the corresponding PHP version. There are
three section with self-explanatory names: `aded` (for functions/methods that
Copy link
Collaborator

Choose a reason for hiding this comment

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

typo on added

Copy link
Collaborator

@orklah orklah left a comment

Choose a reason for hiding this comment

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

Should we bother explaining here the subtleties like '1 when multiple signature exists, & for reference parameters, the fact that Psalm does not follow signature to the letter when param types or return types are the result of developper errors (typically when param became TypeError later) ? Maybe even that functions in callmap are pure by default?

Or maybe keep those out of the simple guide not to afraid contributors?

@weirdan
Copy link
Collaborator Author

weirdan commented Sep 4, 2021

I intended that as a simple guide indeed. This can be expanded if we observe people confused by subtleties.

@weirdan weirdan merged commit 2e9a3cb into vimeo:master Sep 4, 2021
@weirdan weirdan deleted the document-callmaps branch September 4, 2021 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants