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

Improvements to documentation #2248

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Conversation

mjhopkins
Copy link

A bunch of minor improvements to the documentation.

Scala

  • formatting
  • fix ({double bracketing})
  • write Quill uniformly (not quill). Likewise sbt not SBT
  • spaces after commas and inside braces for improved legibility

English

  • fix typos
  • improve grammar

Notes

Additional notes.

Checklist

  • Unit test all changes
  • Update README.md if applicable
  • Add [WIP] to the pull request title if it's work in progress
  • Squash commits that aren't meaningful changes
  • Run sbt scalariformFormat test:scalariformFormat to make sure that the source files are formatted

@getquill/maintainers

@mjhopkins
Copy link
Author

At the moment I can't build this, because

curl "http://apache.volia.net/cassandra/$CASSANDRA_VERSION/apache-cassandra-$CASSANDRA_VERSION-bin.tar.gz"

refers to a path that does not exist on the host (CASSANDRA_VERSION=3.11.10).

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@guizmaii
Copy link
Member

guizmaii commented Sep 29, 2023

@mjhopkins These files have moved. Could you please backport your changes to the new files, please?

You'll also need to sign the ZIO cla before we can merge your PR

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.

4 participants