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

Where exactly do AutoDoc comments for declarations have to appear? #267

Open
zickgraf opened this issue Oct 10, 2022 · 0 comments
Open

Where exactly do AutoDoc comments for declarations have to appear? #267

zickgraf opened this issue Oct 10, 2022 · 0 comments

Comments

@zickgraf
Copy link
Contributor

We sometimes use something like to following for documenting an operation which has already been declared in a more general version (note the line if false then between the AutoDoc comments and the Declare...):

#! @Description
#!  Delegates to <C>ObjectInFpCategory</C>( <A>C</A>,  <A>V</A> ).
#! @Arguments V, A
#! @Returns an object in a &CAP; category
if false then
DeclareOperation( "\/", [ IsQuiverVertex, IsFpCategory ] );
fi;

This seems to work fine in general but I have now encountered issues with this when using @Group.

Thus the question: Should this be supported, or do AutoDoc comments have to appear right before the Declare...? If this should be supported, I will create a bug report for my issues, else I will update the AutoDoc documentation to explicitly say that comments have to appear right before the Declare....

zickgraf added a commit to zickgraf/FunctorCategories that referenced this issue Oct 12, 2022
Otherwise CreatePreSheafMorphismByValues appears in the wrong group.
gap-packages/AutoDoc#267 tries to clarify if this
is a bug in AutoDoc or working as intended.
kamalsaleh pushed a commit to kamalsaleh/FunctorCategories that referenced this issue Oct 17, 2022
Otherwise CreatePreSheafMorphismByValues appears in the wrong group.
gap-packages/AutoDoc#267 tries to clarify if this
is a bug in AutoDoc or working as intended.
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