Skip to content

docs(readme): use 'user-agent' instead of 'agent' as 'header' option in 'Sentible defauls' section #608

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

Conversation

oscard0m
Copy link
Member

@oscard0m oscard0m commented Jul 9, 2023

No issue for this doc adjustment


Behavior

Before the change?

'Sensible defaults' in README.md talks about headers.agent

After the change?

'Sensible defaults' in README.md talks about headers['user-agent']


Additional info

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Added the appropriate label for the given change

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes (Please add the Type: Breaking change label)
  • No

If Yes, what's the impact:

  • N/A

Pull request type

Type: Documentation


@oscard0m oscard0m requested a review from wolfy1339 July 9, 2023 08:31
@oscard0m oscard0m added the Type: Documentation Improvements or additions to documentation label Jul 9, 2023
@oscard0m oscard0m force-pushed the docs-fix-docs-header-parameter-from-agent-to-user-agent branch from 87a70a1 to 2cd67b8 Compare July 9, 2023 08:41
@oscard0m oscard0m merged commit 0da7c88 into main Jul 9, 2023
@oscard0m oscard0m deleted the docs-fix-docs-header-parameter-from-agent-to-user-agent branch July 9, 2023 13:01
@github-actions
Copy link

github-actions bot commented Jul 9, 2023

🎉 This PR is included in version 8.0.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Type: Documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants