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

Incorrect documentation of symbol and section types #565

Closed
ISSOtm opened this issue Sep 6, 2020 · 3 comments
Closed

Incorrect documentation of symbol and section types #565

ISSOtm opened this issue Sep 6, 2020 · 3 comments
Labels
bug Unexpected behavior / crashes; to be fixed ASAP! docs This affects the documentation (web-specific issues go to rgbds-www) good first issue New to the codebase? You can help no problem!

Comments

@ISSOtm
Copy link
Member

ISSOtm commented Sep 6, 2020

Current documentation misplaces the section unionization bit in the symbol's type field. (It also means that this & is misplaced as well.

Additionally, bit 6 (for section fragments) is not mentioned either.

@avivace avivace added the docs This affects the documentation (web-specific issues go to rgbds-www) label Sep 18, 2020
@ISSOtm ISSOtm added good first issue New to the codebase? You can help no problem! bug Unexpected behavior / crashes; to be fixed ASAP! hacktoberfest labels Sep 20, 2020
@Tawishi
Copy link

Tawishi commented Oct 3, 2020

I would like to work on this issue.

@ISSOtm
Copy link
Member Author

ISSOtm commented Oct 3, 2020

No problem! The file to edit is the same one I linked to in the top post; since I'm not sure we mention it anywhere, the syntax used is mandoc's.

@ISSOtm
Copy link
Member Author

ISSOtm commented Oct 5, 2020

Welp, looks like that has actually already been fixed in ec5a1bc :T

@ISSOtm ISSOtm closed this as completed Oct 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Unexpected behavior / crashes; to be fixed ASAP! docs This affects the documentation (web-specific issues go to rgbds-www) good first issue New to the codebase? You can help no problem!
Projects
None yet
Development

No branches or pull requests

3 participants