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

Predicate docstring in same block #31

Open
susuhahnml opened this issue Dec 19, 2024 · 1 comment
Open

Predicate docstring in same block #31

susuhahnml opened this issue Dec 19, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@susuhahnml
Copy link
Collaborator

If the docstring of two predicates is not in the same comment block then only the first on is obtained

@susuhahnml susuhahnml added the bug Something isn't working label Dec 19, 2024
@VictosVertex
Copy link
Collaborator

If it is -not - in the same comment block? Or rather if it - is - in the same comment block?

The current implementation assumes one comment-block per docstring.

Case 1: this should work

%* 
#some_predicate(A,B,C).
some description|
*%
%* 
#some_other_predicate(A,B,C).
some other description|
*%

Case 2: this should not work and likely results in an odd predicate documentation

%* 
#some_predicate(A,B,C).
some description|

#some_other_predicate(A,B,C).
some other description|
*%

If we want to support case 2 as well (which seems somewhat unusual right? Usually there is one doc string per struct/function/field/whatever), then I think we would have to define some kind of delimiter in order to cleanly separate the different predicates.

Because we have to then differentiate between the start of a new predicate description and the continuation of the previous predicate.

If you're not talking about case 2, can you give an example?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants