search

sourcegraph / srclib

srclib is a polyglot code analysis library, built for hackability. It consists of language analysis toolchains (currently for Go and Java, with Python, JavaScript, and Ruby in beta) with a common output format, and a CLI tool for running the analysis.
https://srclib.org
Other
942 stars 62 forks source link

Documentation: What is the format? #163

Open Meai opened 9 years ago

Meai commented 9 years ago

At the end of the day srclib is a format right? Yet from the website and readme, the actual format is nowhere to be seen. It's like making json but not actually showing what json looks like.

MaikuMori commented 9 years ago

The format can still change, here's some information.

Another option is to look at the structs in the source. Here are some:

Srclib team is currently working on autogenerated documentation from source, but the work is not yet done as far as I know. The source itself is quite well documented.

sqs commented 9 years ago

I agree: the format should be easy to get to from the homepage. Right now you have to click on Docs, then Schema, then one of the items.

jelmerdereus commented 9 years ago

@Meai thanks for your feedback. It's on the wish list already and it will be addressed.