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

Attributes array panel requirements update #32

Open
IronRico opened this issue Jun 16, 2020 · 0 comments
Open

Attributes array panel requirements update #32

IronRico opened this issue Jun 16, 2020 · 0 comments
Assignees
Labels
documentation Deals with documentation updates

Comments

@IronRico
Copy link
Contributor

I was advised that the following section will need to be updated to reflect the panel requirements. Notably, the "Name" attribute does not show up as a required entry.
You can see how it appears in the current mdEditor guide here.

Below is an updated screenshot showing the required fields with the exclamation marks next to them.

image


For the wording under the screenshot on the page, it may be a good idea to include notes that the attributes are required. See the example below:

Code Name {type: string; max length: none; default: empty; Required Field: Yes}
Usage: The code name of the Attribute used in the dictionary schema.

Data Type {type: codelist (ADIwg codes); extensible: YES; multi-value: NO; default: empty; Required Field: Yes}Usage: The data type for this attribute (e.g. character, integer, real).

Definition {type: string; max length: none; default: empty; Required Field: Yes}
Usage: A short narrative definition of the attribute.


Are there other suggestions on this?

@IronRico IronRico added the documentation Deals with documentation updates label Jun 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Deals with documentation updates
Projects
None yet
Development

No branches or pull requests

2 participants