-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
Minor documentation clarification issues with arrays #13427
Comments
No. That is very specifically written that way because array subtypes almost always have type parameters. In those cases, writing it as you have would be wrong, because invariance.
I'd call that ambiguous, not incorrect. A small clarification would be fine. As are more see also sections. There are already quite a few; just arrange your additions to match the existing style. [Edit: removed aside] |
OK, thanks for the info. I do think that is something easy to miss (I've seen a questions about it on julia-users), do you think it deserves maybe an explanation as to why the difference here is critical? I disagree that saying "vector V of nonzero values" is ambiguous - it seems to be stating pretty clearly that the values should only be non-zero, and there is no indication of what would happen if
[Edit: removed response to aside] |
There seem to be some minor issues where the code and the documentation are not consistent,
so before submitting a PR to fix them, I'd like to find out which is actually correct.
Isn't this the same as writing:
Base.linearindexing(::Type{MyArray}) = LinearFast()
?I believe this is incorrect, because in the code, it actually removes any zero values that are in the vector V. Vector V is not restricted to nonzero values.
One final issue is that there is some documentation about the different types of
sort
, which is only present in one variantsort!
(i.e. the description of which algorithm is used, the meaning of theby
andlt
keyword arguments and how they interact).In the manual, it makes sense for that information to be only present once, however, for the help information from doc or
?
, they at least need a line "See alsosort!
" added.I'm not sure if there is any way to handle that cleanly with the new doc system.
The text was updated successfully, but these errors were encountered: