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

Remove unnecessary information from API docs #3209

Merged
merged 1 commit into from
Oct 17, 2023

Conversation

bermr
Copy link
Contributor

@bermr bermr commented Oct 17, 2023

Fixes

Fixes #3208 by @AetherUnbound

Description

Just removed the cURL instructions from every endpoint:

image
image

Testing Instructions

just api/up

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@bermr bermr requested a review from a team as a code owner October 17, 2023 02:37
@openverse-bot openverse-bot added 🟩 priority: low Low priority and doesn't need to be rushed ✨ goal: improvement Improvement to an existing user-facing feature 📄 aspect: text Concerns the textual material in the repository 🧱 stack: documentation Related to Sphinx documentation labels Oct 17, 2023
@obulat obulat requested a review from dhruvkb October 17, 2023 04:11
Copy link
Contributor

@obulat obulat 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 for your contribution, @bermr ! It fixes the issue in question perfectly.
@dhruvkb , I requested your review as you are the person who worked the most on the API documentation.

@sarayourfriend
Copy link
Collaborator

Thanks for the contribution @bermr. I approved before seeing Olga's comment, so I'll wait for Dhruv as well. @dhruvkb if you approve go ahead and merge 🙂

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

I kinda liked that we had that note everywhere, especially because I assume a lot of the readers would visit only the very specific endpoints that they are concerned with and not read the entirety of the API documentation site.

But I don't object, as I hope developers can figure this out.

@dhruvkb dhruvkb changed the title docs: removes unnecessary information from API docs Remove unnecessary information from API docs Oct 17, 2023
@dhruvkb dhruvkb merged commit 8a9f6e1 into WordPress:main Oct 17, 2023
64 of 68 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Remove references to using cURL in the API documentation
5 participants