Skip to content

fix: docs: replace single-quotes with double quotes for Windows compatility #1181

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

Merged
merged 1 commit into from
Mar 19, 2025

Conversation

dsfaccini
Copy link
Contributor

@dsfaccini dsfaccini commented Mar 19, 2025

Ubuntu is indifferent whether we run uv add 'pydantic-ai[option]' or "uv add 'pydantic-ai[option]", but Windows errors with this message:

error: Failed to parse: `'pydantic-ai[logfire]'`
  Caused by: Expected package name starting with an alphanumeric character, found `'`
'pydantic-ai[logfire]'

I'm on Windows 11 Version 24H2, x64 based-processor
Using uv 0.6.6 (c1a0bb85e 2025-03-12) and python 3.12.9
If this is merged, here are other files that I can update: https://github.com/search?q=repo%3Apydantic%2Fpydantic-ai+path%3A%2F%5Edocs%5C%2F%2F+%27pydantic-ai&type=code

Ubuntu is indifferent whether we run `uv add 'pydantic-ai[option]' `or `"uv add 'pydantic-ai[option]"`, but Windows errors with this message:

```
error: Failed to parse: `'pydantic-ai[logfire]'`
  Caused by: Expected package name starting with an alphanumeric character, found `'`
'pydantic-ai[logfire]'
```

I'm on Windows 11 Version 24H2, x64 based-processor
Using uv 0.6.6 (c1a0bb85e 2025-03-12) and python 3.12.9
Copy link
Contributor

hyperlint-ai bot commented Mar 19, 2025

PR Change Summary

Updated installation commands in the documentation for Windows compatibility by replacing single quotes with double quotes.

  • Replaced single quotes with double quotes in installation commands for Windows compatibility
  • Ensured consistent formatting across multiple installation examples
  • Addressed parsing errors specific to Windows users

Modified Files

  • docs/install.md

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

@Kludex
Copy link
Member

Kludex commented Mar 19, 2025

Thanks!

@Kludex Kludex merged commit 8342dbe into pydantic:main Mar 19, 2025
17 checks passed
@dsfaccini dsfaccini deleted the patch-1 branch March 19, 2025 23:31
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.

2 participants