Skip to content

The lint test for function paths has a misleading description #84

@khera

Description

@khera

Improve documentation

Link

Add a link to the page which needs improvement (if relevant)

The description in lints/0011_function_search_path_mutable.sql and also https://supabase.com/docs/guides/database/database-linter?lint=0011_function_search_path_mutable

Describe the problem

Is the documentation missing? Or is it confusing? Why is it confusing?

The description claims that the path is mutable on the condition that it is not set to an empty string. This is not true. If you set the path to search_path = 'public' the path is no longer mutable and it is safe.

Describe the improvement

A clear and concise description of the improvement.

One of two:

  1. Change the test to see if the path is set to any value
  2. Change the description of the linter test to clearly state that the test checks only for empty search path.

The detailed description implies that your expectation is the second one, but the text is not entirely consistent on this point.

Additional context

Add any other context or screenshots that help clarify your question.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions