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

[Jobs] [Doc] Add note about trailing slash for REST API #41561

Merged
merged 1 commit into from
Dec 5, 2023

Conversation

architkulkarni
Copy link
Contributor

It's a common mistake to forget the trailing slash in the URL for the REST API request, and the resulting error is not clear. This PR adds a brief reminder in the docs about the slash.

Why are these changes needed?

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

It's a common mistake to forget the trailing slash in the URL for the REST API request, and the resulting error is not clear.  This PR adds a brief reminder in the docs about the slash.

Signed-off-by: Archit Kulkarni <[email protected]>
Copy link
Contributor

@angelinalg angelinalg left a comment

Choose a reason for hiding this comment

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

We typically avoid using exclamation marks in technical documentation, but it sounds like we really want to warn users of this common trap. Plus it's in the code.

@architkulkarni architkulkarni merged commit b648853 into master Dec 5, 2023
9 of 10 checks passed
@architkulkarni architkulkarni deleted the architkulkarni-patch-2 branch December 5, 2023 00:36
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.

None yet

2 participants