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

[DOCUMENTATION] event descriptor documentation about external field #191

Open
dylanmcreynolds opened this issue Sep 30, 2020 · 1 comment

Comments

@dylanmcreynolds
Copy link
Contributor

Two pieces of documentation in this report could be clearer.

"description": "Where the data is stored if it is stored external to the events."

https://github.com/bluesky/event-model/blob/master/docs/source/event-descriptors.rst
(optional) external --- a string specifying where external data, such as a large image array, is stored

It seems the right answer for many cases is the string
'external': 'FILESTORE:'

but I don't see this in the documentation. I would edit myself in a PR, but I don't know all the things that this was intended to take. The way I read datbroker.core._documents_to_xarray, it maybe doesn't matter what the value is, just that the field is there.

@dylanmcreynolds dylanmcreynolds changed the title event descriptor documentation about external field [DOCUMENTATION] event descriptor documentation about external field Sep 30, 2020
@danielballan
Copy link
Member

From https://blueskyproject.io/event-model/external.html

The presence of the key 'external' indicates that the Events’ 'image' contains a reference to an asset outside the documents. (The value of that key is not currently used by any part of the system; only its existence is checked for. The value may be used in the futue as a hook for integration with outside systems.)

The description in the schema should be updated to reflect this.

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

No branches or pull requests

2 participants