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

Document thread operations #3

Merged
merged 2 commits into from
Aug 23, 2023
Merged

Document thread operations #3

merged 2 commits into from
Aug 23, 2023

Conversation

diversenok
Copy link
Contributor

I wrote some documentation about thread-related functions and types.

@m417z
Copy link
Owner

m417z commented Aug 23, 2023

Wow, that's some high quality content! Why not add an attribution, something like:

# Documented by
* [diversenok](https://github.com/diversenok)

Of course, it's OK if you prefer to keep it as is.

Also, nit: How about removing the dot from the tables? For example:

. Query Set
Type ULONG or BOOL N/A
Required access THREAD_QUERY_INFORMATION N/A
.               | Query                      | Set
--------------- | -------------------------- | ---
Type            | `ULONG` or `BOOL`          | N/A
Required access | `THREAD_QUERY_INFORMATION` | N/A

Option 1:

  Query Set
Type ULONG or BOOL N/A
Required access THREAD_QUERY_INFORMATION N/A
           | Query                      | Set
--------------- | -------------------------- | ---
Type            | `ULONG` or `BOOL`          | N/A
Required access | `THREAD_QUERY_INFORMATION` | N/A

Option 2:

Query Set
Type ULONG or BOOL N/A
Required access THREAD_QUERY_INFORMATION N/A
|                 | Query                      | Set |
| --------------- | -------------------------- | --- |
| Type            | `ULONG` or `BOOL`          | N/A |
| Required access | `THREAD_QUERY_INFORMATION` | N/A |

The second option seems to be more standard:

For compatibility, you should also add a pipe on either end of the row.

https://www.markdownguide.org/extended-syntax/#tables

Edit: I think adding a pipe just at the beginning is good enough. GitHub docs say "The pipes on either end of the table are optional".

@diversenok
Copy link
Contributor Author

How about removing the dot from the tables?

Yeah, good idea. I updated them.

Why not add an attribution

Well, I don't think it would serve any purpose. Maybe you can add me into the footer later once I document enough functions 😉

@m417z
Copy link
Owner

m417z commented Aug 23, 2023

A footer is also an option. Feel free to add it to your next PR here and here. Something like "content by diversenok" will work. It might become less manageable if there will be other major contributors, but we can think about it later if it ever happens.

@m417z m417z merged commit 7ee0ffa into m417z:main Aug 23, 2023
@diversenok diversenok deleted the threads branch August 23, 2023 16:40
@m417z m417z mentioned this pull request Feb 10, 2024
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.

2 participants