-
Notifications
You must be signed in to change notification settings - Fork 24
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
Documentation Improvements for Spark.Dsl.Entity #39
Comments
Question: What are Question: What's the difference between |
Question: What is the examples field for? |
Question: What is an example of an identifier? |
|
The examples field allows you to show examples of a given section or entity. For example: @attribute %Spark.Dsl.Entity{
name: :attribute,
...,
examples: [
"""
attribute :foo, :string
"""
]
} It should be shown in the automatically generated documentation. |
|
To be clear, is that the type set by the user in their If the former, I believe the type would be |
yes, you are correct 👍 |
Proposal
This issues is to keep track of improvement ideas for the documentation for
Spark.Dsl.Entity
.Questions
@doc false
these functions, or write documentation for them?Work to be done
@typedocs
on these types.Spark.OptionsHelper
)mfa()
to{module(), function :: atom(), args :: [any()]}
The text was updated successfully, but these errors were encountered: