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

Corrections to classic format description #53

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Dave-Allured
Copy link

@Dave-Allured Dave-Allured commented Jul 19, 2022

Classic format has three parts, not two.
Also minor edits for readability.

Classic format has three parts, not two.
Also minor edits for readability.
@WardF
Copy link
Member

WardF commented Jul 19, 2022

@ethanrd Ethan, any feedback on this, or (logistically) how it will impact the branch you're working on?

@WardF WardF assigned WardF and ethanrd and unassigned WardF Jul 19, 2022
@WardF WardF added this to the v1.0 milestone Jul 19, 2022
@ethanrd
Copy link
Member

ethanrd commented Jul 22, 2022

Hi @Dave-Allured, @WardF - This seems like a matter of interpretation or preference. The format itself doesn't change whether it is described as two parts (header and data) with the data then broken into two sections (non-record data and record data) or it is described as three parts.

So it doesn't feel like there's a strong need for this change. And since both the text and the BNF specification have historically used the two-part description I think a change should require a strong argument. Do you have a reason beyond preference?

@Dave-Allured
Copy link
Author

@ethanrd, yes, this is a matter of preference. I do not have a strong argument.

However, the current function doc for nc__enddef includes a well written three-part description, not two. I think the user's guide should follow that example. In my experience, awareness of the three parts has been continuously helpful for data set design, performance issues, and related service questions. I rest my case.

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

Successfully merging this pull request may close these issues.

3 participants