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

docs-Add missing math constants to documentation pages of numeric data types and math function module #860

Merged
merged 2 commits into from
Sep 30, 2024

Conversation

matthewjnield
Copy link
Contributor

@matthewjnield matthewjnield commented Sep 18, 2024

Closes #832.

Commit 1:

docs-Add missing math constants to numeric data types documentation page

The documentation page for the numeric data types is missing the following two constants:
math::inf
math::neg_inf

This commit adds the two missing constants.

Commit 2:

docs-Add missing math constants to math function module documentation page

The documentation page for the mathfunction module is missing the following constants:math::frac_1_pi math::frac_1_sqrt_2 math::frac_2_pi math::frac_2_sqrt_pi math::frac_pi_2 math::frac_pi_3 math::frac_pi_4 math::frac_pi_6 math::frac_pi_8 math::ln_10 math::ln_2 math::log10_2 math::log10_e math::log2_10 math::log2_e math::sqrt_2`

This commit adds the missing constants.

… page

The documentation page for the numeric data types is missing the following two constants:
`math::inf`
`math::neg_inf`

This commit adds the two missing constants.
…tion page

The documentation page for the math` function module is missing the following constants:
`math::frac_1_pi`
`math::frac_1_sqrt_2`
`math::frac_2_pi`
`math::frac_2_sqrt_pi`
`math::frac_pi_2`
`math::frac_pi_3`
`math::frac_pi_4`
`math::frac_pi_6`
`math::frac_pi_8`
`math::ln_10`
`math::ln_2`
`math::log10_2`
`math::log10_e`
`math::log2_10`
`math::log2_e`
`math::sqrt_2`

This commit adds the two missing constants.
Copy link

netlify bot commented Sep 18, 2024

Deploy Preview for surrealdb-docs ready!

Name Link
🔨 Latest commit aaf640c
🔍 Latest deploy log https://app.netlify.com/sites/surrealdb-docs/deploys/66ea2faa014adb0008a462bb
😎 Deploy Preview https://deploy-preview-860--surrealdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Dhghomon
Copy link
Contributor

Dhghomon commented Sep 19, 2024

Thank you (again!) for the PR! I've been giving some thought to a unified format for consts vs. functions since right now the data types page has the consts in all caps (including the module path) but all lowercase on the functions page.

I think what might look best is lowercase for the module paths, and all caps for the final part as long as it's a const. Then the functions page would look like this, making it clear which is a function and which is a const:

math::floor
math::INF
math::interquartile

And then the numeric types page would match the format and thus end up like this.

math::E
math::FRAC_1_PI
math::FRAC_1_SQRT_2

I'll tag @Ekwuno to see if he likes the idea.

@Ekwuno
Copy link
Contributor

Ekwuno commented Sep 27, 2024

Apologies for the delay on this @matthewjnield I think it's alright as is. I will merge it in now

Thank you (again!) for the PR! I've been giving some thought to a unified format for consts vs. functions since right now the data types page has the consts in all caps (including the module path) but all lowercase on the functions page.

I think what might look best is lowercase for the module paths, and all caps for the final part as long as it's a const. Then the functions page would look like this, making it clear which is a function and which is a const:

math::floor math::INF math::interquartile

And then the numeric types page would match the format and thus end up like this.

math::E math::FRAC_1_PI math::FRAC_1_SQRT_2

I'll tag @Ekwuno to see if he likes the idea.

@Ekwuno Ekwuno merged commit 07724c0 into surrealdb:main Sep 30, 2024
4 checks passed
@matthewjnield matthewjnield deleted the math_constants branch October 25, 2024 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants