Skip to content

Small improvements to repo analysis docs #4413

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

DaveCTurner
Copy link

  • Reflows the text so it's all sentence-per-line.

  • Improves the one-line summary at the top of the article.

  • Explains why you must run increasingly large analyses rather than just accepting the first run.

  • Expands the docs about why failures are bad even if snapshots appear to work.

  • Mentions verifying the reference implementation before reporting ES bugs.

* Reflows the text so it's all sentence-per-line.

* Improves the one-line summary at the top of the article.

* Explains why you must run increasingly large analyses rather than just
  accepting the first run.

* Expands the docs about why failures are bad even if snapshots appear
  to work.

* Mentions verifying the reference implementation before reporting ES
  bugs.
Copy link
Contributor

Following you can find the validation results for the API you have changed.

API Status Request Response
snapshot.repository_analyze Missing test Missing test

You can validate this API yourself by using the make validate target.

@DaveCTurner DaveCTurner added the skip-backport This pull request should not be backported label May 24, 2025
Copy link
Contributor

Following you can find the validation results for the API you have changed.

API Status Request Response
snapshot.repository_analyze Missing test Missing test

You can validate this API yourself by using the make validate target.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-backport This pull request should not be backported specification
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant