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

Documentation typo #2561

Merged
merged 8 commits into from
May 3, 2024
Merged

Conversation

Sumit112192
Copy link
Contributor

📝 Description

Type: : 📝 documentation

A mathematical typo

$$\rho_{\mu}(\mu) = \frac{1}{2}\qquad \text{for } -1\le \mu \le 1$$

For: $-1\le \mu \le 1$
$$f_{\mu}(\mu) = \int_{-\infty}^{\mu} \rho_{\mu} d{\mu}$$

$$f_{\mu}(\mu) = \int_{-1}^{\mu} \frac{1}{2} d{\mu}$$

$$f_{\mu}(\mu) = \frac{1}{2}(\mu + 1)$$

🚦 Testing

How did you test these changes?

  • Testing pipeline
  • Other method (describe)
  • My changes can't be tested (explain why)

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes
  • I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.
@wkerzendorf @andrewfullard Please review.

@tardis-bot
Copy link
Contributor

*beep* *bop*

Hi, human.

I'm the @tardis-bot and couldn't find your records in my database. I think we don't know each other, or you changed your credentials recently.

Please add your name and email to .mailmap in your current branch and push the changes to this pull request.

In case you need to map an existing alias, follow this example.

Copy link

codecov bot commented Mar 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.18%. Comparing base (1718002) to head (145974f).
Report is 12 commits behind head on master.

❗ Current head 145974f differs from pull request most recent head d83c0ba. Consider uploading reports for the commit d83c0ba to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2561   +/-   ##
=======================================
  Coverage   68.18%   68.18%           
=======================================
  Files         168      168           
  Lines       14219    14219           
=======================================
  Hits         9695     9695           
  Misses       4524     4524           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@andrewfullard
Copy link
Contributor

Good catch! Can you also remove the subscript mu because it doesn't really mean anything here.

@Sumit112192
Copy link
Contributor Author

image
Should I remove the subscript $\tau$ as well?

@andrewfullard
Copy link
Contributor

andrewfullard commented Apr 19, 2024

Should I remove the subscript τ as well?

Yes please.

Removed the subscript as it was evident from the expression which variable the distribution is referred to.
@andrewfullard andrewfullard merged commit b4d3568 into tardis-sn:master May 3, 2024
9 checks passed
@Sumit112192 Sumit112192 deleted the Documentation_Typo branch May 3, 2024 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants