Skip to content

/ amp

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

Jump to bottom

Adding documentation for static analysis tools #305

Open
dantleech opened this issue Mar 28, 2020 · 2 comments
Open

Adding documentation for static analysis tools #305

dantleech opened this issue Mar 28, 2020 · 2 comments
Labels
documentation

Comments

@dantleech
Copy link

@dantleech dantleech commented Mar 28, 2020 •
edited

Hey,

Has any thought been given to supporting phpstan/psalm generics e.g.

class Foo
{
    /**
     * @return Promise<MyDomainThing>
     */
    public function wait(): Promise { // ... }
}

Otherewise, what's the best way to document a Promise that's compatible with SA tools?

Psalm has some stubs for Amp: https://github.com/vimeo/psalm/blob/master/src/Psalm/Internal/Stubs/Amp.php
@enumag
Copy link
Contributor

@enumag enumag commented Mar 28, 2020

See #301
@enumag
Copy link
Contributor

@enumag enumag commented Mar 28, 2020

But yeah we might want to apply the rest of the Psalm stubs too.
@dantleech dantleech changed the title How to document Promise types / generics? Adding generic docs for SA tools Mar 28, 2020
@dantleech dantleech mentioned this issue Mar 28, 2020
Closed
@kelunik kelunik changed the title Adding generic docs for SA tools Adding documentation for static analysis tools Apr 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
@dantleech @enumag @kelunik
You can’t perform that action at this time.