-
Notifications
You must be signed in to change notification settings - Fork 198
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
Fix code example formatting in docs #1610
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sfc-gh-jreini
changed the title
Fix a lot of formatting in docs
Fix code example formatting in docs
Oct 30, 2024
sfc-gh-jreini
requested review from
sfc-gh-chu,
sfc-gh-pdharmana and
sfc-gh-pmardziel
October 30, 2024 17:29
dosubot
bot
added
the
size:XL
This PR changes 500-999 lines, ignoring generated files.
label
Oct 30, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Looks good to me! Reviewed everything up to a1b682d in 48 seconds
More details
- Looked at
1239
lines of code in15
files - Skipped
0
files when reviewing. - Skipped posting
5
drafted comments based on config settings.
1. docs/component_guides/evaluation/feedback_aggregation.md:18
- Draft comment:
The text mentionsaggregate(numpy.min)
but the code example usesnp.mean
. Ensure consistency between the text and the code example. - Reason this comment was not posted:
Confidence changes required:50%
The PR aims to fix code example formatting in the documentation by using admonitions. The changes are consistent across multiple files, ensuring that code examples are properly formatted and highlighted. This improves readability and consistency in the documentation. The changes are straightforward and do not affect the functionality of the codebase.
2. docs/component_guides/evaluation/feedback_anatomy.md:18
- Draft comment:
The text mentionsaggregate(numpy.mean)
but the code example usesnp.mean
. Ensure consistency between the text and the code example. - Reason this comment was not posted:
Confidence changes required:50%
The PR aims to fix code example formatting in the documentation by using admonitions. The changes are consistent across multiple files, ensuring that code examples are properly formatted and highlighted. This improves readability and consistency in the documentation. The changes are straightforward and do not affect the functionality of the codebase.
3. docs/component_guides/evaluation/feedback_selectors/selecting_components.md:56
- Draft comment:
The text mentions evaluating items separately or collecting them into an array for evaluation with.collect()
. Ensure that the explanation matches the code example provided. - Reason this comment was not posted:
Confidence changes required:50%
The PR aims to fix code example formatting in the documentation by using admonitions. The changes are consistent across multiple files, ensuring that code examples are properly formatted and highlighted. This improves readability and consistency in the documentation. The changes are straightforward and do not affect the functionality of the codebase.
4. docs/component_guides/evaluation/running_feedback_functions/existing_data.md:15
- Draft comment:
Ensure that the explanation of running feedback functions on existing data is clear and matches the code example provided. - Reason this comment was not posted:
Confidence changes required:50%
The PR aims to fix code example formatting in the documentation by using admonitions. The changes are consistent across multiple files, ensuring that code examples are properly formatted and highlighted. This improves readability and consistency in the documentation. The changes are straightforward and do not affect the functionality of the codebase.
5. docs/component_guides/evaluation/running_feedback_functions/existing_data.md:30
- Draft comment:
Ensure that the explanation of usingTruVirtual
to ingest and evaluate logs is clear and matches the code example provided. - Reason this comment was not posted:
Confidence changes required:50%
The PR aims to fix code example formatting in the documentation by using admonitions. The changes are consistent across multiple files, ensuring that code examples are properly formatted and highlighted. This improves readability and consistency in the documentation. The changes are straightforward and do not affect the functionality of the codebase.
Workflow ID: wflow_UK2c3e6pHDIlIpUI
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet
mode, and more.
sfc-gh-dhuang
approved these changes
Oct 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
lgtm
This PR has been approved by a maintainer
size:XL
This PR changes 500-999 lines, ignoring generated files.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Mostly admonitions, fixing existing and adding where they should exist
Other details good to know for developers
Please include any other details of this change useful for TruLens developers.
Type of change
not work as expected)
Important
This pull request improves documentation by adding admonitions to code examples for better formatting and clarity across multiple files.
feedback_aggregation.md
,feedback_anatomy.md
,feedback_selectors/index.md
, and several others.This description was created by for a1b682d. It will automatically update as commits are pushed.