docs: add therory doc#261
Conversation
github-actions
Bot
added
the
documentation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #261 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 13 13
Lines 366 366
=========================================
Hits 366 366 Flags with carried forward coverage won't be shown. Click here to find out more. |
Documentation build overview
9 files changed ·
|
for more information, see https://pre-commit.ci
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
The PR introduces a statistical theory document and updates the site configuration. While the content addition is clear, there are two primary concerns: the PR title contains a typo ('therory'), and the configuration introduces a reference to api.md, which is not present in the repository, likely resulting in a broken navigation link. Additionally, a notation error was identified in the LaTeX math symbols within the new document. Please address the missing file reference and the notation correction.
About this PR
- The PR title contains a typo ('therory' should be 'theory') and the description field is empty. Providing a brief summary helps reviewers and future maintainers.
Test suggestions
- Verify that 'Theory Reference' in zensical.toml correctly maps to the newly created theory.md file.
- Verify that 'API Reference' in zensical.toml maps to a valid api.md file.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify that 'API Reference' in zensical.toml maps to a valid api.md file.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
| { "相关系数" = "models/correlation/inequality.md" } | ||
| ] }, | ||
| { "API Reference" = "api.md" } | ||
| { "API Reference" = "api.md" }, |
There was a problem hiding this comment.
🟡 MEDIUM RISK
The documentation configuration now references 'api.md', but this file was not added in this pull request. If it does not exist in the repository, the documentation build or navigation will fail.
| @@ -0,0 +1,25 @@ | |||
| ## 大数定律 | |||
|
|
|||
| 当样本量 $n \Rightarrow \infty$ 时，样本比例 $\hat{p}$ 依概率收敛于总体比例 $p$，即 | |||
There was a problem hiding this comment.
⚪ LOW RISK
Nitpick: The notation for a limit (n approaching infinity) should use a single arrow \to rather than the logical implication symbol \Rightarrow.\n\nsuggestion\n当样本量 $n \to \infty$ 时，样本比例 $\hat{p}$ 依概率收敛于总体比例 $p$，即\n
Up to standards ✅🟢 Issues
|
1 participant
No description provided.