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

Make corrections to docs #1065

Merged
merged 14 commits into from
Jul 22, 2023
Merged

Conversation

ColeFrench
Copy link
Contributor

@ColeFrench ColeFrench commented Jul 16, 2023

Hi! This is my first time contributing to this project, and I hope to make (many) more contributions.

This PR generally "updates" the Tectonic book. The substance of these updates is ensuring the documented command usage matches the actual usage displayed by the CLI. This fixes #1057 and other issues people may open about this.

To review those corrections, you can look at these commit ranges:

Since I am doing some bulk text changing and formatting anyway, I thought I would include grammar fixes in this PR as well. Those make up the rest of the file changes.

@codecov
Copy link

codecov bot commented Jul 16, 2023

Codecov Report

Merging #1065 (86f3312) into master (a2865a6) will increase coverage by 0.02%.
The diff coverage is n/a.

❗ Current head 86f3312 differs from pull request most recent head 96d77dc. Consider uploading reports for the commit 96d77dc to get more accurate results

@@            Coverage Diff             @@
##           master    #1065      +/-   ##
==========================================
+ Coverage   45.83%   45.85%   +0.02%     
==========================================
  Files         171      171              
  Lines       64145    64180      +35     
==========================================
+ Hits        29398    29427      +29     
- Misses      34747    34753       +6     
Impacted Files Coverage Δ
src/unstable_opts.rs 57.37% <ø> (+0.71%) ⬆️

... and 29 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@ColeFrench ColeFrench marked this pull request as ready for review July 21, 2023 16:50
@ColeFrench ColeFrench changed the title Make small corrections to docs Make corrections to docs Jul 21, 2023
@pkgw
Copy link
Collaborator

pkgw commented Jul 22, 2023

Wow, thank you! I appreciate the careful editing and polish that you've put in here. The changes aren't always obvious but I think that it's quite valuable to correct things like "which"/"that" mistakes, and clearly you've given things a close read.

If you're motivated, any further contributions to the documentation are extremely welcome — unfortunately, Tectonic has heretofore continued the long-standing TeX tradition of having rather poor HTML documentation, which is something that I would love to see change. I have my own projects aiming to tackle that, but I've completely overwhelmed by work responsibilities lately (I feel like I've been writing that for the past 3-4 years ...) and it would be fantastic to have more people working on things!

@pkgw pkgw merged commit 004530b into tectonic-typesetting:master Jul 22, 2023
26 checks passed
@ColeFrench ColeFrench deleted the book-updates branch July 22, 2023 15:37
@ColeFrench
Copy link
Contributor Author

Thanks! I'm glad my contributions are welcome. Hopefully, as I get more in tune with the code, I'll find more things to improve or add to the documentation.

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.

v2: compile missing --open option
2 participants