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

add documentation to precise mode #22762

Merged
merged 4 commits into from
Sep 6, 2023
Merged

add documentation to precise mode #22762

merged 4 commits into from
Sep 6, 2023

Conversation

MahmoudAshraf97
Copy link
Contributor

PR Description

This PR adds documentation to Precision mode to datatypes deepdive
it is still missing some code examples but I don't know if they are needed

@github-actions
Copy link
Contributor

Thanks for contributing to Ivy! 😊👏
Here are some of the important points from our Contributing Guidelines 📝:
1. Feel free to ignore the run_tests (1), run_tests (2), … jobs, and only look at the display_test_results job. 👀 It contains the following two sections:
- Combined Test Results: This shows the results of all the ivy tests that ran on the PR. ✔️
- New Failures Introduced: This lists the tests that are passing on main, but fail on the PR Fork. Please try to make sure that there are no such tests. 💪
2. The lint / Check formatting / check-formatting tests check for the formatting of your code. 📜 If it fails, please check the exact error message in the logs and fix the same. ⚠️🔧
3. Finally, the test-docstrings / run-docstring-tests check for the changes made in docstrings of the functions. This may be skipped, as well. 📚
Happy coding! 🎉👨‍💻

Copy link
Contributor

@KareemMAX KareemMAX left a comment

Choose a reason for hiding this comment

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

@MahmoudAshraf97,
LGTM overall, I've left some comments that I want to know what do you think about them. I guess we also may need to add some examples, I guess one example for precise mode and one for non-precise would be enough

docs/overview/deep_dive/data_types.rst Outdated Show resolved Hide resolved
docs/overview/deep_dive/data_types.rst Outdated Show resolved Hide resolved
docs/overview/deep_dive/data_types.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@KareemMAX KareemMAX left a comment

Choose a reason for hiding this comment

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

LGTM!

@KareemMAX KareemMAX merged commit 8b6d96d into ivy-llc:main Sep 6, 2023
133 checks passed
druvdub pushed a commit to druvdub/ivy that referenced this pull request Oct 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants