Skip to content

Missing reference documentation for configuration parameters #13178

Open
@hw0lff

Description

Possible values for the enum typed parameters and their descriptions are not shown in the rust analyzer manual.
In the Configuration section of the manual are only the names of configuration parameters, their description and their default value displayed.
The configuration parameters are not just booleans. They contain number and enum types too.
These two types are missing important parts of their documentation.

For example:

  1. The entry of the number parameter cachePriming.numThreads is lacking that this parameter only accepts values between 0 and 255.
  2. The entry of the enum parameter lifetimeElisionHints.enable is missing the possible values it can take and their descriptions.

No one is able to correctly guess what options it can hold and finding out the possible values is very time-consuming and impractical.
Right now I have to look into editors/code/package.json to get a look at all enum options and their descriptions.

The required information is technically already existent in that package.json. The most obvious solution would be to somehow generate the documentation from the package.json.

P.S.: I had to manually find out the anchors by looking at the html source. Is there any way to make this easier?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    A-documentationdocs for rust-analyzer usage/inner workingBroken WindowBugs / technical debt to be addressed immediately

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions