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

Add Prototype Pseudocode #79

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Add Prototype Pseudocode #79

wants to merge 10 commits into from

Conversation

nibanks
Copy link
Member

@nibanks nibanks commented Jun 8, 2023

No description provided.

@mtfriesen
Copy link
Contributor

Can this go in its own file? The qeo_ndis header is meant to contain NDIS definitions for QEO.

@nibanks
Copy link
Member Author

nibanks commented Jun 8, 2023

Can this go in its own file? The qeo_ndis header is meant to contain NDIS definitions for QEO.

It could, but it's going to get deleted eventually anyways, so why does it matter?

@mtfriesen
Copy link
Contributor

mtfriesen commented Jun 8, 2023

This seems like it belongs in markdown; the point of this header file is to take the code snippets in the QEO markdown file and produce something an actual compiler will accept. Why would we prefer putting non-compiling, commented-out pseudo code into the compiler-readable header file rather than a human-readable markdown file, which also provides the opportunity for rich text description between code blocks?

@nibanks
Copy link
Member Author

nibanks commented Jun 8, 2023

This seems like it belongs in markdown; the point of this header file is to take the code snippets in the QEO markdown file and produce something an actual compiler will accept. Why would we prefer putting non-compiling, commented-out pseudo code into the compiler-readable header file rather than a human-readable markdown file, which also provides the opportunity for rich text description between code blocks?

Done.

@mtfriesen
Copy link
Contributor

I don't want to be super nit-picky, but why is the markdown file in the include directory?

I guess I'm just a bit lost: what is the intent of this pseudo code? Is this meant to be a non-normative extension of the QEO spec, sample code, or something driver developers actually include in their projects?

include/psuedocode.md Outdated Show resolved Hide resolved
@nibanks
Copy link
Member Author

nibanks commented Jun 8, 2023

I want it close to the actual source since it's generally meant to help describe how you will use it. Right now I want to focus on the content, not the location/format.

include/psuedocode.md Outdated Show resolved Hide resolved
include/psuedocode.md Outdated Show resolved Hide resolved
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