Skip to content

Update component-design-guidelines.md #38349

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Dec 4, 2023
Merged

Update component-design-guidelines.md #38349

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73da7f1
Update component-design-guidelines.md
smoothdeveloper Nov 21, 2023
fb8928f
Update component-design-guidelines.md
smoothdeveloper Nov 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/fsharp/style-guide/component-design-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,8 @@ Adding the `[<RequireQualifiedAccess>]` attribute to a module indicates that the

This is useful when functions and values in the module have names that are likely to conflict with names in other modules. Requiring qualified access can greatly increase the long-term maintainability and evolvability of a library.

It is strongly suggested to have the `[<RequireQualifiedAccess>]` attribute for custom modules that extend those provided by `FSharp.Core` (such as `Seq`, `List`, `Array`), as those modules are prevalently used in F# code and have `[<RequireQualifiedAccess>]` defined on them; more generally, it is discouraged to define custom modules lacking the attribute, when such module shadows or extend other modules that have the attribute.

Adding the `[<AutoOpen>]` attribute to a module means the module will be opened when the containing namespace is opened. The `[<AutoOpen>]` attribute may also be applied to an assembly to indicate a module that is automatically opened when the assembly is referenced.

For example, a statistics library **MathsHeaven.Statistics** might contain a `module MathsHeaven.Statistics.Operators` containing functions `erf` and `erfc`. It is reasonable to mark this module as `[<AutoOpen>]`. This means `open MathsHeaven.Statistics` will also open this module and bring the names `erf` and `erfc` into scope. Another good use of `[<AutoOpen>]` is for modules containing extension methods.
Expand Down