Skip to content

Naming for hidden items that have to be public #243

@kgv

Description

@kgv

For example, if we want to use structure fields or some function inside a macro but don't want them to be part of the API, we mark them as hidden.

pub struct Struct {
    /// This is an implementation detail and **should not** be used directly!
    #[doc(hidden)]
    pub __field: u8,
}

I think it would be useful to specify a naming convention for these cases.

Relevant links:

What does it signify to precede a variable name with two underscores? __var
Down a Rusty Rabbit Hole

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions