Skip to content

Conversation

@Minnozz
Copy link
Contributor

@Minnozz Minnozz commented Jun 19, 2021

Fixes #190

@ryyppy
Copy link
Member

ryyppy commented Jun 21, 2021

This looks generally pretty good.

A few things:

  • Not sure if we should call the sidebar navigation item Compiler Warnings... sounds more like an FAQ collection of error messages (problem -> solution). Maybe Warning Numbers would be better?
  • I noticed that our Warnings collection has deviated from upstream (still a bunch of BuckleScript words in there). Here's the most up to date list: warnings.ml

Probably unrelated to this list, but I also wanted to have a simple text field to fuzzy find particular warning numbers by description. In a similar manner how we did it with the Syntax Lookup Widget (using the Fuse.res bindings), but this can be done in another task.

@Minnozz Minnozz marked this pull request as ready for review June 21, 2021 08:53
@ryyppy
Copy link
Member

ryyppy commented Jun 21, 2021

Nice! One last thing:

Can we change the link within this section to point to the new warning-number list?

That will be the last change, otherwise it looks perfect!

@Minnozz
Copy link
Contributor Author

Minnozz commented Jun 21, 2021

We might want to link to the new warning list (or embed <WarningTable />) on some more pages: #190 (comment), most useful would be the syntax widget I think.

@ryyppy
Copy link
Member

ryyppy commented Jun 21, 2021

We might want to link to the new warning list

Yeah, in the attribute page we could add a link to the warning list in the description here:
image

You can find a full list of all available warnings [here](...)

most useful would be the syntax widget I think

I'd not include the whole table into different pages... should be enough to link to it, no? In the Syntax widget we use the See section to link to canonical resources

@Minnozz
Copy link
Contributor Author

Minnozz commented Jun 21, 2021

I've added some more links to and from the Warning Numbers page, and I also added the @@warning decorator to the syntax widget. I'm not entirely sure if I'm correct that it operates on the module level; somewhere else it is stated that it operates on the file.

@ryyppy
Copy link
Member

ryyppy commented Jun 21, 2021

this is looking sleek. Thanks!

@ryyppy ryyppy merged commit fbbc41b into rescript-lang:master Jun 21, 2021
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.

Add available warning numbers for @@warning()

3 participants