Small corrections in docs validate.md #271
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alyst
reviewed
Jan 29, 2024
docs/source/validate.md
Outdated
| @@ -214,11 +214,11 @@ X = hcat([4., 5.] .+ 0.4 * randn(2, 10), | |||
| [9., -5.] .+ 0.4 * randn(2, 5), | |||
| [-4., -9.] .+ 1 * randn(2, 5)) | |||
|
|
|||
| nclusters = 2:5 | |||
| clusterings = kmeans.(Ref(X), nclusters) | |||
| №_clu = 2:5 | |||
There was a problem hiding this comment.
I think "№" symbol typically denotes "sequential number", e.g. "cluster №3", but not the quantity of items.
There was a problem hiding this comment.
I am no expert here, I always thought it is just old abbreviation for "number" with no further nuance. We can change to n_clu or something similar.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #271 +/- ##
=======================================
Coverage 95.40% 95.40%
=======================================
Files 20 20
Lines 1503 1503
=======================================
Hits 1434 1434
Misses 69 69 ☔ View full report in Codecov by Sentry. |
|
I have tried to tweak the layout of the plots and switched to SVG, let's see if that helps. |
|
The updates did fix the dev docs. |
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Third attempt at making this PR. I made a new repository and commit from a branch this time.
Corrections in links + changing
nclustersto№_clu. There is a functionnclustersalready.Something is deeply wrong with
Plotswhen it compiles official docs for validate.md. Not only it puts titles on labels, it also does not display some labels at all. I cannot reproduce it on two different machines, so currently I have no idea how to fix it.EDIT. Looking more closely maybe it renders those labels, but they do not into the plot frames. Maybe we can try updating
Plotsversion in docs?