Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Warn if typespec references filtered module #1761

Merged

Conversation

viniciusmuller
Copy link
Contributor

This PR updates the retriever to also return a list of filtered modules, and updates the code to warn if we find a typespec that references a type from a filtered module.

Closes #1744

{{:type, AutolinkTest.Filtered, :type, 0}, :public}
])

# TODO: testing
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like some guidance here, I was able to check the fix with a local project but I'm not sure what would be the best way to test this.

Also, maybe we should create a new test case for this, as it's a bit more complex than the other cases that are based only on autolink

@josevalim josevalim merged commit 960e2ef into elixir-lang:main Sep 7, 2023
4 checks passed
@josevalim
Copy link
Member

💚 💙 💜 💛 ❤️

@viniciusmuller
Copy link
Contributor Author

Are we going to add the test or it's not necessary for this? 👀

@josevalim
Copy link
Member

A PR with tests is welcome!

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

Successfully merging this pull request may close these issues.

Using filter_modules doesn't produce warning referencing hidden or private docs
2 participants