Page MenuHomePhorge
Create Task
Maniphest T16045

All @{method:...} links in Diviner docs result in a "Documentation Not Found" error
Open, Needs TriagePublic
Actions

Description

Steps to reproduce:

Expected result:
Documentation.

Actual result:

Documentation Not Found
Unable to find the specified documentation. You may have followed a bad or outdated link.

Note that this is not a 404 error like in T16044.

Related Objects

Event Timeline

aklapper created this task.Wed, Apr 30, 14:33
Herald added subscribers: Cigaryno, Matthew, chris, tobiaswiese. · View Herald TranscriptWed, Apr 30, 14:33
aklapper added a comment.Wed, Apr 30, 14:58

A quick fix would be removing the single line $query->withIsDocumentable(true); in https://we.phorge.it/source/phorge/browse/master/src/applications/diviner/controller/DivinerFindController.php;85f51c54303fe50ebc09ee0b652033a8a9f29ab1$45
as that'll allow results for Methods.

It's unclear to me what that isDocumentable boolean is good for anyway. Seems to be a duplication of types:

MariaDB [phabricator_diviner]> SELECT COUNT(type), type, isDocumentable FROM diviner_livesymbol GROUP BY type, isDocumentable;
+-------------+-----------+----------------+
| COUNT(type) | type      | isDocumentable |
+-------------+-----------+----------------+
|         158 | article   |              1 |
|        5868 | class     |              1 |
|        6084 | file      |              0 |
|          33 | function  |              1 |
|          47 | interface |              1 |
|       38246 | method    |              0 |
+-------------+-----------+----------------+
6 rows in set (0.047 sec)

After removing that single line you'd run into T16044: Diviner: All Method and File query results have invalid 404 URIs (getting a 404 error instead of Documentation Not Found).

aklapper mentioned this in Z5: Phorge (flame).Wed, Apr 30, 14:59
aklapper mentioned this in T16044: Diviner: All Method and File query results have invalid 404 URIs.Wed, Apr 30, 15:30
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0