Skip to content

Guidelines for documenting intended vs actual behavior #2037

Description

@ehuss

I think the authoring guide should have some guidance on whether to document the actual behavior of rustc vs the intended behavior, and how to handle known bugs.

If there is a known issue, should it be encouraged or discouraged to link to the GitHub issue?

Should it have specific callouts for future-incompatible warnings? How should these known problems be documented? Should it document how it is intended to work? What if the intention is not yet known?

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Authoring guideIssues for the authoring guide and style guidelinesMetaNon-content issues (procedure, tooling, website, etc.)

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions