search

PreTeXtBook / pretext

PreTeXt: an authoring and publishing system for scholarly documents
https://pretextbook.org
Other
254 stars 203 forks source link

Guide: Update CLI documentation for v2.0 #2066

Closed oscarlevin closed 8 months ago

oscarlevin commented 8 months ago

A large update to the CLI sections of the guide to coincide with CLI version 2.0. Quickref has also been updated.

Also a couple typo fixes that I came across.

oscarlevin commented 8 months ago

We are ready to announce CLI 2.0 as soon as this gets merged.

rbeezer commented 8 months ago

This was in the queue during a push of merging PRs the past few days, but it got delayed for a less-productive time since it has quite a few tedious whitespace errors that I was going to correct. Biggest is some comments used for file headers getting shortened, which will disrupt using sed to update copyrights. (Others are line endings, file ending, iirc.)

Thanks! -Rob

oscarlevin commented 8 months ago

I can definitely take care of those issues. Must have been an autoformatter that messed with the top-of-file comments.

For the whitespace, it looks like the formatter removed existing whitespace between sentences. Is this an issue? Does the guide have a preferred number of spaces after a period?

rbeezer commented 8 months ago

Spaces after a period does not really matter. I use more blank lines rather than fewer, but there are no guidelines.

It is trailing whitespace and "blank" lines that are not blank that are most at issue, generally.

One person adds them, then somebody else makes a PR, touches an unrelated file, their editor "fixes" these things, and poof, you've got a diff that makes no sense. Best to be religious about not letting it in the first place. ;-)

oscarlevin commented 8 months ago

Should be all better now.

rbeezer commented 8 months ago

30 minutes spent trying to get the fixes into the proper commits. And then I see there is still some trailing spaces.

Can you git reset HEAD~5, fix whitespace, and then rebuild two or three topical commits? I can walk you through this on Tuesday if you'd like.

oscarlevin commented 8 months ago

I'll close this and start over.