org-element discovered inconsistensies

[ihor <ihor@antonovs.family>]

[-- Attachment #1: Type: text/plain, Size: 4155 bytes --]

So these are things that I have discovered so far:

     Property Drawer:
        - Element in 
https://orgmode.org/worg/dev/org-element-api.html#orgf47acc7
          It also states that it has :properties field which is simply 
not there in the code
https://code.orgmode.org/bzg/org-mode/src/master/lisp/org-element.el#L1514
          My assumption in is that Property Drawer contains Node 
Properties directly, as children, instead of :properties filed

        - Greater Element in 
https://orgmode.org/worg/dev/org-syntax.html#Property_Drawers
        - Greater Element in source code 
https://code.orgmode.org/bzg/org-mode/src/master/lisp/org-element.el#L233


      Node Property:
        - Element in 
https://orgmode.org/worg/dev/org-syntax.html#Node_Properties
        - Missing from https://orgmode.org/worg/dev/org-element-api.htm
        - Greater Element in source code 
https://code.orgmode.org/bzg/org-mode/src/master/lisp/org-element.el#L226

      Line Break:
        - Object in https://orgmode.org/worg/dev/org-syntax.html#Line_Breaks
        - Element in https://orgmode.org/worg/dev/org-element-api.htm
        - Object in source code 
https://code.orgmode.org/bzg/org-mode/src/master/lisp/org-element.el#L239

Secondly, function that collects affiliated keywords 
(|org-element--collect-affiliated-keywords) |

https://code.orgmode.org/bzg/org-mode/src/master/lisp/org-element.el#L3988

does not take  granularity 
(https://code.orgmode.org/bzg/org-mode/src/master/lisp/org-element.el#L4076) 
as argument

and parse objects any way:

https://code.orgmode.org/bzg/org-mode/src/master/lisp/org-element.el#L4029

https://code.orgmode.org/bzg/org-mode/src/master/lisp/org-element.el#L4036

Is there a reason behind this or is this a bug?


On 5/29/19 11:43 PM, Nick Dokos wrote:
> Ngor <ngortheone@gmail.com> writes:
>
>> Hi Org community.
>>
>> I am re-posting my questions here according to Nicolas' recommendation.
>>
>> I am working on a standalone parser implementation for Org which is basically a translation of elisp program to Rust
>> https://github.com/org-rs/org-rs
>>
>> There are couple of things I wanted to ask about:
>>
>> 1) I have discovered several inconsistencies and errors in the Syntax/API documentation
>> https://orgmode.org/worg/dev/org-element-api.html vs https://orgmode.org/worg/dev/org-syntax.html vs elisp source
>> And I don't know the right way to report them.
>>
>> 2) I think I have found a bug in the algorithm (org-element-collect affiliated keywords does not take granularity into accound and seems to be always parsing objects in Caption
>> keyword)
>>
>> 3) I have a question regarding the elisp source source (specifically about the :parent of the parsed objects of the keyword)
>>
>> I can elaborate on each point but I don't want to overwhelm everybody with details right from the start. I guess the meta-question is where and how
>> should I discuss these points? - I never used mailing lists before (If I did something incorrectly or do not follow the established rituals/traditions please do not judge me harshly.
>> )
>>
> No need for metaquestions: ask away.
>
> You might want to report related problems together, but if the
> connection is tenuous or non-existent, then separate posts to the
> mailing list will probably work better. Asking your question in a
> separate post is probably best, so it doesn't get lost in the forest
> of detail when reporting problems.
>
> If you suspect a bug, then use 'M-x org-submit-bug-report`: the bug
> report will end up here and will contain a lot of information about
> your set-up which might be helpful.
>
> Finally, be patient: do not expect answers (particularly when the
> questions are complicated, as it seems yours will be). It takes
> a while for people to get around to even reading the posts, let
> alone coming up with answers (or, as is likely, more quesions for
> you).
>
> And welcome to mailing lists in general and this mailing list in
> particular!
>

[-- Attachment #2: Type: text/html, Size: 7854 bytes --]