Skip to content

Require all public symbols be documented #33

Description

@Notgnoshi

Motivated by #30 (reply in thread)

It appears we can achieve this through judicious use of #[warn(missing_docs)] and the existing use of -Dwarnings in the CI/CD pipeline. https://doc.rust-lang.org/rustdoc/write-documentation/what-to-include.html

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

    ci/cdRelated to automated pipelinesdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions