Skip to content

Adapt doc-valid-idents config to support list expansion instead of replacement #8877

Closed
@xFrednet

Description

@xFrednet

Description

The config value doc-valid-idents for doc_markdown is a list of allowed identifiers. I've seen some projects overriding them and only adding a few new values. It would be nice if the user also had the option to append new values to the list instead of replacing them.

I was thinking of something like a dummy value .. that indicates that the default list should only be expanded. For example:

doc-valid-idents = ["OverRide"] # => Only `OverRide` is allwed 
doc-valid-idents = ["..", "Append"] # => Clippy's default plus override is allowed

This is just one suggestion, feel free to suggest other options :)

Version

Any *

Additional Labels

No response

Metadata

Metadata

Assignees

Labels

C-an-interesting-projectCategory: Interesting projects, that usually are more involved design/code wise.C-enhancementCategory: Enhancement of lints, like adding more cases or adding help messages

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions