Skip to content

docs: missing docs about warnings or deprecation warnings #5040

@Uzlopak

Description

@Uzlopak

Prerequisites

  • I have written a descriptive issue title
  • I have searched existing issues to ensure the issue has not already been raised

Issue

I could not find any hints regarding deprecation warnings in the docs.

After I added fastify/process-warning#83 to extend the documentation regarding process-warning I think we should add similar information to the docs. I mean a paragraph about how to suppress warnings (on their own risk) would be good.

Also we could make an extra page about deprecation warnings. Similar to errors.md. We should note since which version a deprecation warning was introduced, and how you can update your code to avoid the deprecation warning. Benefit is also, that you could then just copy paste that for a migration guide. So everytime we introduce a deprecation warning, we just need to make sure that the deprecations.md (name pending) also has a new entry with proper information.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions