shafik wrote:
I would hate to lose the non-diagram part of this documentation. Do the
criticism mainly apply to the diagrams and the text documentation is ok for
most?
https://github.com/llvm/llvm-project/pull/66436
___
cfe-commits mailing list
cfe-c
https://github.com/smcpeak closed
https://github.com/llvm/llvm-project/pull/66436
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
smcpeak wrote:
As the feedback has been mostly negative, I'm closing this PR.
https://github.com/llvm/llvm-project/pull/66436
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
smcpeak wrote:
And more generally, is there a preferred overall approach to documenting AST
structures? My basic idea was to follow the example set by the [The AST
Library](https://clang.llvm.org/docs/InternalsManual.html#the-ast-library) in
the Internals Manual, but expanded to cover templat
smcpeak wrote:
Is there a different tool and/or style of diagram that would be preferable?
https://github.com/llvm/llvm-project/pull/66436
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-comm
erichkeane wrote:
Even after seeing your explaination, I don't find the images particularly
useful or helpful. They are convoluted and confusing, and I don't think they
add value here.
As far as being checked in: First, Git does really poorly with binary files.
Second, if we were doing some
smcpeak wrote:
# On the utility of the diagrams
I'm surprised this is a point of contention. Could someone elaborate on why
the diagrams are troublesome? To me, saying that the diagrams are not useful
is sort of like saying the `-ast-dump` output is not useful. Isn't it better
to be able t
erichkeane wrote:
> TBH, not sure if the UML diagrams would really help anyone understand what's
> going on.
I tend to agree with this, the documentation via these diagrams is confusing me
as well, it doesn't really seem to add anything (and in fact, seem to be
'subtracting' in my case).
Tha
smcpeak wrote:
Hi Tom! :)
Indeed, any documentation brings with it an ongoing maintenance burden.
There are two main things I see that need synchronization: the text
descriptions of the fields, and the diagrams.
For the fields, one idea I had is to write a script that runs as part of the
te
tahonermann wrote:
Hi, Scott! It's nice to see you pop up here! :)
I'm a little concerned about maintenance of this documentation going forward.
As you know, the Clang AST is not intended to be stable and, even though I
don't expect dramatic changes to how templates are represented, it will ta
tbaederr wrote:
TBH, not sure if the UML diagrams would really help anyone understand what's
going on.
https://github.com/llvm/llvm-project/pull/66436
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listi
https://github.com/shafik review_requested
https://github.com/llvm/llvm-project/pull/66436
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
https://github.com/shafik review_requested
https://github.com/llvm/llvm-project/pull/66436
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
https://github.com/shafik review_requested
https://github.com/llvm/llvm-project/pull/66436
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
https://github.com/llvmbot labeled
https://github.com/llvm/llvm-project/pull/66436
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
15 matches
Mail list logo
