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

Avoid uninformative DESCRIPTION elements #43

Open
mbtaylor opened this issue May 7, 2020 · 0 comments
Open

Avoid uninformative DESCRIPTION elements #43

mbtaylor opened this issue May 7, 2020 · 0 comments

Comments

@mbtaylor
Copy link
Contributor

mbtaylor commented May 7, 2020

Including descriptive DESCRIPTION elements is good practice, but ones that just contain boilerplate are not much use.

Sec 3.2 says:

The TABLE must include:

  • A human-readable DESCRIPTION that ideally conveys enough human-readable information that basic scientific use of the time series is possible without referring to literature.

I don't think this should be a MUST: authors who have no good description will just have to write something uninformative in here, which is not helpful. So I'd make that a SHOULD.

On a similar topic, the DESCRIPTIONs in the examples in sections 3.1 (photcal_PARAM.xml) and 4.1 (vot-ex1-GROUP.xml) read:

<DESCRIPTION>Photometric system description</DESCRIPTION>

which doesn't say anything additional to the name="PHOTCAL" label. Can something more informative be put in there?

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

No branches or pull requests

1 participant