Skip to content

Conversation

davidlehn
Copy link
Contributor

@davidlehn davidlehn commented Mar 7, 2020

Sort the descriptions to match the ordered enum list above.


💥 Error: 500 Internal Server Error 💥

PR Preview failed to build. (Last tried on Mar 15, 2020, 7:58 PM UTC).

More

PR Preview relies on a number of web services to run. There seems to be an issue with the following one:

🚨 Spec Generator - Spec Generator is the web service used to build specs that rely on ReSpec.

🔗 Related URL

Navigation timeout of 30000 ms exceeded

If you don't have enough information above to solve the error by yourself (or to understand to which web service the error is related to, if any), please file an issue.

Sort the descriptions to match the ordered enum list above.
@davidlehn davidlehn requested a review from gkellogg March 7, 2020 22:53
@davidlehn
Copy link
Contributor Author

Also sorted RemoteDocument descriptions to match IDL above.

@davidlehn
Copy link
Contributor Author

Hmm. Maybe this isn't needed and the RemoteDocument dl is just missing data-sort attribute? If that's the case, the proper patch is probably to add the data-sort attribute and manually resort the JsonLdErrorCode list to match the sorting data-sort does. (just piping through "sort" puts the IRI thing at top and orders some things slightly different)

Copy link
Member

@gkellogg gkellogg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use data-sort.

@davidlehn
Copy link
Contributor Author

For IDL sections, I assume it's desired to have the IDL item list match the description list. If descriptions are using data-sort, then should the IDL item order match that? And if the IDL items are ordered in data-sort order, seems the markup descriptions should use that order too. So then everything ends up manually sorted. Is that the idea? data-sort seems a nice indicator, but I guess it's redundant.

@gkellogg
Copy link
Member

Method parameters should stay in order, and of course, algorithm steps. Otherwise, I think we can use data-sort.

It's not too important that the HTML source be ordered if we're using data-sort, and sometimes it made sense to keep things out of order, but mostly to catch issues where things were't properly ordered in the source. It's fine to re-order the source to match what is ordered with data-sort.

@iherman
Copy link
Member

iherman commented Mar 13, 2020

This issue was discussed in a meeting.

  • No actions or resolutions
View the transcript [api] Order JsonLdErrorCode descriptions
Benjamin Young: #409
Gregg Kellogg: other is reordering error code. Normally we use <dl> with data-sort attribute that orders them, but this maybe doesn’t use data-sort
… so need to get the text in the HTML to align with the sort order
David I. Lehn: ordering thing is not very exciting :)
… if we use data-sort it will put it in a particular order. And the IDL should be the same order as the -sort
… everything should be ordered the same. Wasn’t sure what to do, and ran out of time on it
Gregg Kellogg: up to the editors for what to do. Doesn’t affect the rendered document at all. Do things exist in the source where you expect them … so a good idea to have in the same order. data-sort corrects for past errors
… if someone wants to do it, that’s great
David I. Lehn: I sorted the values by piping through sort locally
… which put IRI at the top
Gregg Kellogg: Good to just do what the algorithm does
David I. Lehn: Will just make it look right :)
Gregg Kellogg: don’t sort method param lists
… as they’re in the order they’re used in the method definition
… but error codes, enum values don’t order by default
… and need to be done manually, but keeping the enum in the order below makes the most sense
… IRI comes first due to caps
… whereas in data-sort it’s after invalid
David I. Lehn: Which things to not sort?
Gregg Kellogg: in jsonld processor interface, the definitions of the methods, there’s definitions of the three params … those should not be ordered alphabeitcally but in the order they appear in the method definition
David I. Lehn: Right, okay. I’ll work on an update
Gregg Kellogg: Great, need to sign off
… will push syntax today
Benjamin Young: Great, thanks, bye!
… revisit 415?
Rob Sanderson: [crickets]

@gkellogg gkellogg merged commit cce11c1 into master Mar 15, 2020
@gkellogg gkellogg deleted the idl-order branch March 15, 2020 20:02
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