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.

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

Jump to bottom

[5.x+]ucar.ma2.StructureData is insufficiently documented #766

Open
haileyajohnson opened this issue Jul 16, 2021 · 1 comment
Open

[5.x+]ucar.ma2.StructureData is insufficiently documented #766

haileyajohnson opened this issue Jul 16, 2021 · 1 comment
Labels
docs: content Content related documentation tasks public api Issues regarding the netCDF-Java Public API

Comments

@haileyajohnson
Copy link
Member

The documentation on ArrayStructures does not provide and example of how to read and write data to a structure member, e.g. creating a StructureData object, writing with NetcdfFormatWriter.appendStructureData, and reading with Structure.readStructure.
@haileyajohnson haileyajohnson added docs: content Content related documentation tasks public api Issues regarding the netCDF-Java Public API labels Jul 16, 2021
@JohnLCaron
Copy link
Collaborator

All deprecated in favor of ucar.array.StructureData in > 5.
Which is also insufficiently documented.

Your decision on documenting ver5, I know this will remain Unidata's version for the foreseeable future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs: content Content related documentation tasks public api Issues regarding the netCDF-Java Public API
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JohnLCaron @haileyajohnson