Skip to content

Fix HTML formatting and update normative changes#387

Draft
TallTed wants to merge 60 commits into
w3c:mainfrom
TallTed:patch-1
Draft

Fix HTML formatting and update normative changes#387
TallTed wants to merge 60 commits into
w3c:mainfrom
TallTed:patch-1

Conversation

@TallTed

@TallTed TallTed commented Jun 8, 2026

Copy link
Copy Markdown
Member

Makes list items end consistently with ., and makes some tab indents into space indents, to match the majority of existing indents.

Fixes #386.


Preview | Diff

Makes list items end consistently with `.`, and makes some tab indents into space indents, to match the majority of existing indents.
Comment thread spec/index.html Outdated
<li><a href="https://www.w3.org/2013/sparql-errata#errata-query-23">errata-query-23</a>: Fix inconsistenties between <a href="#defn_aggMin">MIN</a> and <a
href="#defn_aggMax">MAX</a></li>
<li><a href="https://www.w3.org/2013/sparql-errata#editorial-query-1">editorial-query-1</a>:
Missing right parenthesis in <a href="#defn_evalGraph">Evaluation of Graph definition</a></li>

@afs afs Jun 8, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

and makes some tab indents into space indents

This PR introduces tabs.

cat -A:
+^I^I^I^I Missing right parenthesis in <a href="#defn_evalGraph">Evaluation of Graph definition</a></li>$

Please replace with spaces.
Indent in the document is 2 spaces per level.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Very strange. I know for a fact I did not type any tabs; part of the point of this PR was to replace tabs with spaces! It seems that GitHub "helped" me.

I did indent the <li> content with 4 spaces, because it made for clearer viewing, but I have backed those off to 2 spaces now.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please check "Files changed".

They are now extensive changes - yes, the doc has sporadic tabs; if the intention is to change these, then do it while retaining layout.

The <li> you changed are 4 spaces, including in the editorial changes section where it was correct.

When opening this file, GitHub changed my edit settings from spaces to tabs, and from 4 to 2. I manually changed these back, and did a regex search for `\i`. There were scattered tabs throughout, as well as the concentration around line `13100`.

I believe they've all *really* been cleaned now, and won't switch back.
Comment thread spec/index.html Outdated
<ul>
<li>Update grammar for triple terms, reifiers, reified triples, annotation syntax, and triple term functions
in <a href="#sparqlGrammar" class="sectionRef"></a></li>
in <a href="#sparqlGrammar" class="sectionRef"></a>.</li>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is 4 spaces of indent.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

argh. revisiting.

Comment thread spec/index.html Outdated
syntax as links to their respective definition; similarly, mark up all
mentions of operators of the <a href="#sparqlAlgebra">SPARQL algebra</a>
as links to their respective definition</li>
(<a href="#algebraicSyntax" class="sectionRef"></a>) into which the AST

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This was correct, now there is 4 space indent.

@TallTed TallTed left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I may scream. A lot. GitHub has done the "helpful" thing of forbidding pull request authors from requesting changes on their own pull request. So I have 58 pending comments which request changes, fixing the now-incorrect space runs. Which I think I can apply through an edit on my branch, manually copying each now-comment line from this review. They were applicable, one-by-one, not in a batch, so this will need a squash-merge. But I think it's ready now.

Comment thread spec/index.html Outdated
Comment thread spec/index.html Outdated
Comment thread spec/index.html Outdated
Comment thread spec/index.html Outdated
Comment thread spec/index.html Outdated
Comment thread spec/index.html Outdated
Comment thread spec/index.html Outdated
Comment thread spec/index.html Outdated
Comment thread spec/index.html Outdated
Comment thread spec/index.html Outdated
@TallTed

TallTed commented Jun 10, 2026

Copy link
Copy Markdown
Member Author

@afs — I hope I've gotten them all right this time.

@afs afs marked this pull request as draft June 11, 2026 08:38
@afs

afs commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Look at the "File changes". Is that what you want to change throughout the document?
Or just the normative changes section?

Grammar: Lines 12050-12685
All changes to the grammar will be lost because it is machine generated.
Please don't change this section. It makes managing the grammar more difficult if the spec and the generated output do not align.

FYI:
There are currently (main) only 425 log lines. 60 is a lot more.
The main branch is protected - once a commit is merged to main it is permanent - we only append commits to it.

The PR is now 60 commits which is 60 lines of log messages. These will need squashing.
To avoid this accidentally getting merged before it's clean, I've set it to draft.

@TallTed

TallTed commented Jun 11, 2026

Copy link
Copy Markdown
Member Author

Look at the "File changes". Is that what you want to change throughout the document?
Or just the normative changes section?

I want to eliminate tab characters throughout the document, yes.

All changes to the grammar will be lost because it is machine generated.

I would like to improve the grammar section (by eliminating tabs therein, among whatever other changes are currently in this PR) by whatever means is necessary. There is no marker of which I'm aware, informing reviewers that the grammar section is machine generated. This seems to me to be a problem. At minimum, I hope it is possible to tell me how to submit change requests against the generator such that the changes I've suggested for its output are applied.

The PR is now 60 commits which is 60 lines of log messages. These will need squashing.

Yes. I believe I commented to that effect (squash commit will be needed) in one of the earlier commits now in this PR. This need results from the fact that GitHub no longer lets the author of a PR submit a change request on that PR; only comments. I suppose I could have started with the whole document, put it in a text editor, made all the changes I wanted, copied all that text, and overwritten the document I started with as one commit, changing the same 60ish lines.

I'm really not trying to make your, my, nor anyone else's life more difficult. I'd be happy to work on this within a concall of whatever shape, if that would help you.

@afs

afs commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

All the grammar tables for all the languages are machine generated, and machine checked.

@TallTed

TallTed commented Jun 12, 2026

Copy link
Copy Markdown
Member Author

Inline notation of such machine generation tends to be helpful in preventing human-generated change suggestions.

Reject what you will, accept what you will. I would appreciate some sort of comment on each rejected change suggestions, even if it's simply "machine generated artefact" or the like.

@afs

afs commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Reject what you will, accept what you will.

It isn't practical to work through the individual commits one-by-one.

A separate PR for just the alternations to the "Changes" section - the semantic changes! - would be helpful.
Then the rest might be amenable to bulk review.

@TallTed

TallTed commented Jun 15, 2026

Copy link
Copy Markdown
Member Author

I do wish you'd have requested this before I produced this PR. I'll try to satisfy this new revision request in the next few days.

@TallTed TallTed self-assigned this Jun 15, 2026
@afs

afs commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

I do wish you'd have requested this before I produced this PR.

The original description was

Makes list items end consistently with ., and makes some tab indents into space indents, to match the majority of existing indents.

except the PR added tabs and misaligned text.

I asked:

This PR introduces tabs.

cat -A:
+^I^I^I^I Missing right parenthesis in Evaluation of Graph definition$

Please replace with spaces.
Indent in the document is 2 spaces per level.

Your second commit blames the tools.

@TallTed

TallTed commented Jun 15, 2026

Copy link
Copy Markdown
Member Author

Rereading the history, I see a case of several misunderstandings, and yes, some blame for the tools in GitHub's web-interface. I believe I understand your frustration with what I've been sending. I'm not going to try to explain my frustration, because I think that would lead to further misunderstandings.

I believe I see a path to relatively quick production of —

A separate PR for just the alternations to the "Changes" section - the semantic changes! - would be helpful.
Then the rest might be amenable to bulk review.

— which I expect to be one commit each. If all goes to plan, they'll be done tomorrow.

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.

1 list item should be 2. All list items should end with ..

4 participants