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

Consistent HTML formatting #315

Merged
merged 8 commits into from
Oct 10, 2024
Merged

Consistent HTML formatting #315

merged 8 commits into from
Oct 10, 2024

Conversation

decentralgabe
Copy link
Collaborator

@decentralgabe decentralgabe commented Oct 9, 2024

No normative changes. Purely editorial for consistency.


Preview | Diff

index.html Outdated
with JSON Object Signing and Encryption
(<a href="https://datatracker.ietf.org/wg/jose/about/">JOSE</a>),
Selective Disclosure for JWTs [[SD-JWT]], and CBOR Object Signing and
Encryption (COSE) [[RFC9052]]. This enables the Verifiable Credential
Copy link
Collaborator

Choose a reason for hiding this comment

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

"CBOR Object Signing and Encryption" is broken across lines, when it's a term that should be searchable and so needs to be on a single line.

index.html Outdated
// ReSpec
var respecConfig = {
group: "vc",

Copy link
Collaborator

Choose a reason for hiding this comment

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

It's better not to have any whitespace at the end of lines.

Copy link
Collaborator

@selfissued selfissued left a comment

Choose a reason for hiding this comment

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

If we're going to change the line breaks in the source, we should be employing Semantic Line Breaks, so that the source can easily be searched for terms because the terms are never broken across lines.

The simple form of these rules is that:

  1. Line breaks should never occur within a sentence, except after punctuation marks, such as commas.
  2. There should always be a line break after periods ending sentences (but not those indicating abbreviations).

Before we merge this, I'd also like to understand how we are going to verify that no changes to the output occurred. (When doing changes like this, it's easy for stray characters to creep in or be deleted due to manual errors.)

Thanks.

@decentralgabe
Copy link
Collaborator Author

I've applied (most of) the feedback. I believe the html is more readable now. I've removed trailing whitespaces and checked for any lost content (could not find anything).

index.html Outdated Show resolved Hide resolved
Copy link
Collaborator

@selfissued selfissued left a comment

Choose a reason for hiding this comment

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

Looks good now

@decentralgabe
Copy link
Collaborator Author

only formatting changes. merging.

@decentralgabe decentralgabe merged commit 0bf848a into main Oct 10, 2024
2 checks passed
@decentralgabe decentralgabe deleted the fix-format branch October 10, 2024 19:58
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