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

Properly document IsVoidMatrix, IsInitialMatrix, IsInitialIdentityMatrix, ... #284

Open
fingolfin opened this issue Aug 29, 2019 · 0 comments

Comments

@fingolfin
Copy link
Member

Many "documented" properties in homalg actually have no meaningful description; they just say this in their documentation comment:

##    <Returns><C>true</C> or <C>false</C></Returns>
##    <Description>
##      <A>A</A> is a &homalg; matrix.
##    </Description>

That's not helpful in the least. Sure, for some of them, one can guess, but I have e.g. no idea what IsVoidMatrix means.

@fingolfin fingolfin changed the title Document what IsVoidMatrix, IsInitialMatrix, IsInitialIdentityMatrix, actually mean Properly document IsVoidMatrix, IsInitialMatrix, IsInitialIdentityMatrix, ... Aug 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant