RPGHacker / asar

(Now) official repository of the SNES assembler Asar, originally created by Alcaro
Other
199 stars 42 forks source link

Add documentation about error/warnings IDs along with the error message #228

Closed Atari2 closed 7 months ago

Atari2 commented 2 years ago

This PR adds a small change to the docs to add 2 tables that have the association ID->name->small description for both errors and warnings. I found myself needing this more than once so I thought might as well add it.

The tables are auto-generated from asar's source code. They can be improved later (and they should), but this is a base stub that works and has all the information someone might need.

This could close #156 but that's up to the maintainers.

RPGHacker commented 2 years ago

This could be useful. I think I recall someone asking for this, but I don't quite remember who or where.

I have a few suggestions:

Atari2 commented 2 years ago

When I say "auto-generated" I mean:

Atari2 commented 2 years ago

@RPGHacker Added a script to automate the generation of the HTML tables.

RPGHacker commented 2 years ago

Thanks, this definitely looks a lot more maintainable. I'll check it out in more detail later and then see if I can merge it.

randomdude999 commented 7 months ago

this is less useful now that we use the internal names instead of numeric IDs, but i guess it might still be nice to have. but the script needs to be fixed now that we don't use the numbers anymore.

also i think there are a few unused warnings and errors (in asar 2 at least). should review those aswell

randomdude999 commented 7 months ago

i updated the script myself and reworked it a bit, will commit shortly