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

docs: various improvements to Python API tutorial #196

Merged
merged 6 commits into from
Nov 13, 2023

Conversation

agilgur5
Copy link
Contributor

@agilgur5 agilgur5 commented Nov 11, 2023

Summary

Several documentation improvements to the Python API tutorial

Originally started to fix the same note as #187, but noticed several other improvements that could be made

Details

  • additions:

    • add link to the Python API reference
    • add link to the FAQ for getting API keys
  • stylistic improvements:

    • simplifications:
      • "databases are databases" is redundant
      • "default configuration is applied by default" is redundant
      • also remove redundant words like "that"; state directly instead
      • see also k8s style guide on direct language (which I use and reference often for docs -- it's a pretty great style guide!)
    • remove duplications:
      • remove duplicate "learn more" configuration link
      • remove duplicate note on the demo assistant
    • consistency + parallelism:
      • use same formatting for Vector DB choices as LLM choices
        • i.e. bold + code backticks
      • for demo helpers, consistently use "Not x. Instead y. It provides a quick way [...]"
        • previously this had a few different formats, different conjunctions, etc
        • parallelism & consistency makes this easier to understand
    • code style:
  • fix various spelling and grammar errors and typos:

    • "it's" -> "its"
      • "it's" = "it is", "its" = possessive
    • no comma needed after "And"
    • comma splice in "vector database, and similar" -> split into two sentences
    • comma splice in "actual database, but" -> split into two sentences
    • "databases at can" -> "databases that can"
    • "in as objects" -> "as objects"
    • "You select the" -> "Select the"

- additions:
  - add link to the Python API reference
  - add link to the FAQ for getting API keys

- stylistic improvements:
  - simplifications:
    - "databases are databases" is redundant
    - "default configuration is applied by default" is redundant
    - also remove redundant words like "that"; state directly instead
    - see also [k8s style guide on direct language](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language) (which I use and reference often for docs -- it's a pretty great style guide)
  - remove duplications:
    - remove duplicate "learn more" configuration link
    - remove duplicate note on the demo assistant
  - consistency + parallelism:
    - use same formatting for Vector DB choices as LLM choices
      - i.e. bold + code backticks
    - for demo helpers, consistently use "Not x. Instead y. It provides a quick way [...]"
      - previously this had a few different formats, different conjunctions, etc
      - parallelism & consistency makes this easier to understand
  - code style:
    - remove new line after `!!! note`
      - otherwise most markdown editors will recognize the block as a code block due to the 4 space indentation

- fix various spelling and grammar errors and typos:
  - "it's" -> "its" -- "it's" = "it is", "its" = possesive
  - no comma needed after "And"
  - comma splice in "vector database, and similar" -> split into two sentences
  - comma splice in "actual database, but" -> split into two sentences
  - "databases at can" -> "databases that can"
  - "in as objects" -> "as objects"
  - "You select the" -> "Select the"

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Copy link
Member

@pmeier pmeier left a comment

Choose a reason for hiding this comment

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

Just one minor comment. I let @pavithraes handle the rest.

docs/tutorials/python-api.md Outdated Show resolved Hide resolved
docs/tutorials/python-api.md Show resolved Hide resolved
docs/tutorials/python-api.md Show resolved Hide resolved
pmeier
pmeier previously requested changes Nov 11, 2023
Copy link
Member

@pmeier pmeier left a comment

Choose a reason for hiding this comment

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

@pmeier
Copy link
Member

pmeier commented Nov 11, 2023

Aaaand of course I forgot the most important part: hello @agilgur5 and welcome to the project 👋 Thanks a ton for taking the time to fix our docs. Really appreciate that!

agilgur5 and others added 3 commits November 12, 2023 14:55
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
per review comment (this was otherwise unchanged previously)

Co-authored-by: Philip Meier <github.pmeier@posteo.de>
@agilgur5 agilgur5 requested a review from pmeier November 12, 2023 20:00
@pmeier pmeier removed their request for review November 13, 2023 10:25
@pmeier pmeier dismissed their stale review November 13, 2023 10:26

Redering issue addressed

Copy link
Member

@pavithraes pavithraes left a comment

Choose a reason for hiding this comment

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

Thank you so much, @agilgur5! All your changes look good to me. I've added a minor formatting suggestion flagged by the linter, we can merge after this. :)

docs/tutorials/python-api.md Outdated Show resolved Hide resolved
docs/tutorials/python-api.md Outdated Show resolved Hide resolved
@pavithraes pavithraes added area: documentation 📖 Improvements or additions to documentation type: maintenance 🛠️ Day-to-day maintenance tasks pr-status: changes requested 🧱 labels Nov 13, 2023
@pmeier
Copy link
Member

pmeier commented Nov 13, 2023

Thanks again @agilgur5!

@pavithraes for the future: if there is nothing left other than auto-formatting, it is usually faster to just pull the PR, apply the formatting and push it again instead of waiting yet another round of the review-fix-cycle. If you don't want that, feel free to just comment something along the lines of "please apply the auto formatting so we can merge". No need to flag all instances when CI is doing the same.

@pmeier pmeier merged commit 99b2a35 into Quansight:main Nov 13, 2023
4 checks passed
@agilgur5 agilgur5 deleted the docs-edit-python-tutorial branch November 13, 2023 23:06
pmeier added a commit that referenced this pull request Nov 30, 2023
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Co-authored-by: Philip Meier <github.pmeier@posteo.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 Improvements or additions to documentation pr-status: changes requested 🧱 type: maintenance 🛠️ Day-to-day maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants