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

WIP narrative explanation on Slice #29

Closed
wants to merge 1 commit into from

Conversation

dericed
Copy link
Contributor

@dericed dericed commented Dec 14, 2016

I think it may make the document more readable if some of the structure which is presently defined in code blocks is accompanied by a narrative description. Here’s an example of that approach for slice. This also includes an example of forward-referencing regarding ‘version’. Note: these references appear differently between the pandoc and mmark/rfc2xml outputs.
Comments welcome.

@dericed dericed changed the title add subsections WIP narrative explanation on Slice Dec 14, 2016
@dericed
Copy link
Contributor Author

dericed commented Dec 15, 2016

Thoughts on this approach. I think adding such narratives could be helpful to some readers, though it adds a risk of conflict between the narrative and the code. As an alternate we could better define how to read the code. I don't want to presume too much that it is intuitive.

@dericed
Copy link
Contributor Author

dericed commented Jan 7, 2017

Going to drop this PR in favor of offering some context in the document to explain that C-like code-blocks are used to explain the storage of the components of FFV1.

@dericed dericed closed this Jan 7, 2017
@retokromer
Copy link
Contributor

+1
Yet why «C-like»? Is it not possible to use plain C code-fragments?

@JeromeMartinez
Copy link
Contributor

JeromeMartinez commented Jan 7, 2017

Yet why «C-like»? Is it not possible to use plain C code-fragments?

plain C is more verbose and more difficult to read, and permits lot of traps.
Additionally, plain C adds more constraints (e.g. is the integer type 8-bit or 16-bit? how do you handle integer overflows? it should depend of your design choice,) the spec should be neutral (e.g. consider number as unlimited, as integer overflow methods are specific to each language or CPU or something else)

@retokromer
Copy link
Contributor

I understand your arguments, but I don’t agree with you, except the increased verbosity.

BTW: In my teaching experience, Pascal-style pseudo code is often considered more intuitive than C-style pseudo code by the students.

@JeromeMartinez JeromeMartinez deleted the WIP-adding-narratives branch June 23, 2020 19:16
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.

None yet

3 participants