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.

Sign up for GitHub

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

Jump to bottom

docs | standards on proper names #997

Merged
merged 15 commits into from
Mar 26, 2024
Merged

docs | standards on proper names #997

merged 15 commits into from
Mar 26, 2024

Conversation

markdavidmc0
Copy link
Contributor

Small change - first contribution modifying the README. One liner.

@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. documentation Improvements or additions to documentation labels Mar 13, 2024
@piotrm0
Copy link
Contributor

piotrm0 commented Mar 14, 2024 •
edited

Thanks; can you also add this as a suggestion to proper names formatting in /docs/trulens_eval/contributing/standards.md. I presume this only applies to cases were markdown is used but you can make a point that anyplace where italics can be used, these proper names should formatted as such.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Mar 14, 2024
@joshreini1
Copy link
Contributor

Sorry, approved too fast. Changes to README.md and trulens_eval/README.md need to be made to gh_top_intro.md and intro.md respectively. These files will overwrite the READMEs.

@joshreini1 joshreini1 self-requested a review March 15, 2024 00:00
joshreini1
joshreini1 requested changes Mar 15, 2024
View reviewed changes
Copy link
Contributor

@joshreini1 joshreini1 left a comment

Choose a reason for hiding this comment

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

Please mirror changes in intro.md

@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. and removed size:XS This PR changes 0-9 lines, ignoring generated files. labels Mar 16, 2024
@markdavidmc0 markdavidmc0 changed the title fix: italise TruLens-Eval ref docs | standards on proper names Mar 16, 2024
@markdavidmc0
Copy link
Contributor Author

Happy with changes inverted commas -> italics in /docs/trulens_eval/contributing/standards.md as well?

@joshreini1
Copy link
Contributor

@piotrm0 seems the eval test here gets skipped but the validation hangs, do you know how to fix?

@piotrm0 piotrm0 merged commit f9fbef4 into truera:main Mar 26, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joshreini1 joshreini1 joshreini1 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@markdavidmc0 @piotrm0 @joshreini1