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

RequireQualifiedAccess section #39

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

IanWitham
Copy link
Contributor

Added section for RequireQualifiedAccess, plus slight editing of the preceding "AutoOpen" paragraph, per #31

@IanWitham IanWitham marked this pull request as draft March 18, 2025 00:43
@IanWitham IanWitham closed this Mar 18, 2025
@IanWitham IanWitham reopened this Mar 18, 2025
@IanWitham IanWitham marked this pull request as ready for review March 18, 2025 08:11
statements to avoid pitfalls; `AutoOpen` would sidestep this.
#### Use `AutoOpen` and/or ignore `RequireQualifiedAccess` best practice with caution!

Functions with identical names from different modules will silently "shadow" each other, causing the most recently imported definition to be used instead of the one you might expect. **The compiler will _not_ warn you that this has happened.** Even if your code works, you may encounter compiler errors if the `open` order changes. A [coding convention (MS Learn)](https://learn.microsoft.com/en-us/dotnet/fsharp/style-guide/conventions#sort-open-statements-topologically) exists for `open` statements to avoid pitfalls.
Copy link
Member

Choose a reason for hiding this comment

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

this warning about silent meaning changes is not inaccurate, but I can imagine it scaring people into thinking they might as well be using something typeless. I dont know how I'd convey it, but the only real problem it triggers is inferring the wrong type where it's not pinned, which then manifests as an error some distance away in terms of files or compile time.

Copy link
Member

@bartelink bartelink left a comment

Choose a reason for hiding this comment

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

In general I like this - just added a pondering comment

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

Successfully merging this pull request may close these issues.

2 participants