phan / phan/phan

PHPDoc return type not included in hover text for methods

Open
#4,060 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement language server
Dominant language
PHP
Stars
5.6k
Forks
365
Avg merge
1h 25m
Merged PRs (30d)
6

Description

But the real return type is included for methods, and the phpdoc return type is included for global functions

<?php
class Foo {
    /**
     * Description goes here
     *
     * @return array
     */
    function test($y) {
        return ['y' => $y];
    }
}
$x = new Foo();
$x->test();

Screenshot_2020-07-16_11-00-18

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the provided PHP example and compare hover text for the method with hover text for a global function. Trace how PHPDoc return types are included in hover output; done when the method hover includes its @return array type consistently with global functions.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.