[FIX] Documentation links #3897
Conversation
| @@ -125,7 +125,7 @@ class State(enum.Enum): | |||
|
|
|||
|
|
|||
| class OWTestLearners(OWWidget): | |||
| name = "Test & Score" | |||
| name = "Test and Score" | |||
There was a problem hiding this comment.
This changes the name of the widget in Orange. Which means all schemas that had "Test & Score" before could fail. Please check.
There was a problem hiding this comment.
It works (I checked on an example workflow).
| @@ -94,7 +94,7 @@ class NotEnoughData(ValueError): | |||
|
|
|||
|
|
|||
| class OWKMeans(widget.OWWidget): | |||
| name = "k-Means" | |||
| name = "k-Means clustering" | |||
There was a problem hiding this comment.
This changes the name of the widget and makes it longer. I don't think this is ok. If docs don't match, we can change the docs.
There was a problem hiding this comment.
Changing the name would make this similar to Hierachical and Louvain Clustering (though "clustering" should be capitalized).
There was a problem hiding this comment.
Hierarchical and Louvain can not be used by themselves - "clustering" is part of the name there.
k-Means is clear enough and can be used as a name by itself.
I think we should strive for short widget names, so I would not expand it in this case.
BTW, clustering is already a keyword for k-means so using it in a search lists it alongside other methods.
There was a problem hiding this comment.
Ok. Changed back widget name and changed documentation file name.
| @@ -1,4 +1,4 @@ | |||
| Transform | |||
| Apply Domain | |||
| ========= | |||
There was a problem hiding this comment.
Underscores have to fit the length of the title.
There was a problem hiding this comment.
Also, the change in not reflected in the index.rst. Could you please fix this too?
There was a problem hiding this comment.
Sorry for these continuous comments. The documentation for Apply Domain should be changed to reflect the changes in the widget name. Namely the references to the widget, image names (so we know what they refer to) and likely the example workflows.
There was a problem hiding this comment.
Done.
Apply Domain (ex Transform) not present in example workflows.
There was a problem hiding this comment.
Sorry, I didn't mean example workflows in Orange tutorial section, but workflows that are in Example section of the documentation.
| @@ -1,4 +1,4 @@ | |||
| Predictions | |||
| Confusion Matrix | |||
| =========== | |||
Codecov Report
@@ Coverage Diff @@
## master #3897 +/- ##
=======================================
Coverage 84.29% 84.29%
=======================================
Files 384 384
Lines 72749 72749
=======================================
Hits 61327 61327
Misses 11422 11422 |
rokgomiscek
force-pushed
the
documentation_fix
branch
from
b2c7da8
to
3943bac
Compare
rokgomiscek
force-pushed
the
documentation_fix
branch
from
3943bac
to
0dd0d15
Compare
Issue
Some widgets reported missing documentation even if this wasn't the case.
Description of changes
Fixed names so documentation links point to the right file.
Includes