Skip to content

Standard practices for incomplete/semi-experimental methods #49296

@Tokazama

Description

@Tokazama

It's pretty hard to figure out what's going on in Julia Base for newbies given all the undocumented internals. There are a lot of comments but those are poorly maintained and have variable quality. I propose we require documentation with some standard !!! warning Unstable API for all methods that are used throughout Julia Base but are not intended for public use.

This is related to #48819, but it's probably safe to add a documentation requirement to the contributors guide prior to any other bells and whistles.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsThis change adds or pertains to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions