Skip to content

docs: remove api methods section #666

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 4 commits into from
Mar 25, 2022

Conversation

Shinigami92
Copy link
Member

@Shinigami92 Shinigami92 commented Mar 24, 2022

We now have a autogenerated better documentation site for the api methods
The readme would just get outdated
In addition it's just a huge block of text and you cannot easily find anything it it, so when confronted with that readme I personally just scroll over it and think: "too much, wont read"

@Shinigami92 Shinigami92 requested a review from a team as a code owner March 24, 2022 11:25
@Shinigami92 Shinigami92 self-assigned this Mar 24, 2022
@Shinigami92 Shinigami92 added the c: docs Improvements or additions to documentation label Mar 24, 2022
@Shinigami92 Shinigami92 added the p: 1-normal Nothing urgent label Mar 24, 2022
@ST-DDT ST-DDT requested a review from a team March 24, 2022 11:28
@codecov
Copy link

codecov bot commented Mar 24, 2022

Codecov Report

Merging #666 (f0d06ba) into main (a299c22) will not change coverage.
The diff coverage is n/a.

❗ Current head f0d06ba differs from pull request most recent head 5046a5a. Consider uploading reports for the commit 5046a5a to get more accurate results

@@           Coverage Diff           @@
##             main     #666   +/-   ##
=======================================
  Coverage   99.34%   99.34%           
=======================================
  Files        1923     1923           
  Lines      176859   176859           
  Branches      895      895           
=======================================
  Hits       175700   175700           
  Misses       1103     1103           
  Partials       56       56           

@ejcheng ejcheng added the s: accepted Accepted feature / Confirmed bug label Mar 24, 2022
@Shinigami92 Shinigami92 enabled auto-merge (squash) March 25, 2022 18:33
@Shinigami92 Shinigami92 merged commit 9291b62 into main Mar 25, 2022
@Shinigami92 Shinigami92 deleted the docs-remove-api-methods-section-from-readme branch March 25, 2022 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants