Skip to content

Documentation fixes #2002

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

Closed
wants to merge 13 commits into from
Closed

Documentation fixes #2002

wants to merge 13 commits into from

Conversation

EdLichtman
Copy link
Contributor

Description

Fixes some misleading documentation (ParameterType.GetOrPost was suggesting that it was a Cookie Parameter, and UrlSegmentParameter suggested it modifies the Query String) and adds additional documentation (adds information to the ResponseStatus to explain what each Response Status means).

Also, adds tests to ensure UrlSegment operates properly and as an enhanced form of documentation for users looking into this code.

Purpose

This pull request is a:

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

alexeyzimarev and others added 11 commits November 23, 2022 22:31
… pretty fatal so you would not want this to silently show up in the Exception response value. (restsharp#1967)
Bumps [coverlet.collector](https://github.com/coverlet-coverage/coverlet) from 3.1.2 to 3.2.0.
- [Release notes](https://github.com/coverlet-coverage/coverlet/releases)
- [Commits](https://github.com/coverlet-coverage/coverlet/commits/v3.2.0)

---
updated-dependencies:
- dependency-name: coverlet.collector
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [JetBrains.Annotations](https://github.com/JetBrains/JetBrains.Annotations) from 2022.1.0 to 2022.3.1.
- [Release notes](https://github.com/JetBrains/JetBrains.Annotations/releases)
- [Commits](https://github.com/JetBrains/JetBrains.Annotations/commits)

---
updated-dependencies:
- dependency-name: JetBrains.Annotations
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json) from 13.0.1 to 13.0.2.
- [Release notes](https://github.com/JamesNK/Newtonsoft.Json/releases)
- [Commits](JamesNK/Newtonsoft.Json@13.0.1...13.0.2)

---
updated-dependencies:
- dependency-name: Newtonsoft.Json
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Adds more Parameter Tests
@dnfadmin
Copy link

dnfadmin commented Jan 31, 2023

CLA assistant check
All CLA requirements met.

Copy link
Contributor

@tacosontitan tacosontitan left a comment

Choose a reason for hiding this comment

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

Overall, this looks like a solid contribution to the documentation for the library.

@alexeyzimarev
Copy link
Member

Would you be able to make this PR targeting the v109 branch instead of dev?

@EdLichtman EdLichtman changed the base branch from dev to v109 February 22, 2023 16:49
@EdLichtman
Copy link
Contributor Author

Hrm... It seems I may need to pull latest v109, otherwise I may be including commits and changes that you guys aren't ready to put into v109.

@EdLichtman EdLichtman closed this Feb 22, 2023
Copy link
Contributor

@tacosontitan tacosontitan left a comment

Choose a reason for hiding this comment

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

REDACTED; reviewed prior to refreshing and seeing base change and closure.

@tacosontitan tacosontitan mentioned this pull request Feb 22, 2023
2 tasks
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.

10 participants