jq icon indicating copy to clipboard operation
jq copied to clipboard

feature request: libjq documentation

Open sergey-safarov opened this issue 2 years ago • 2 comments

On the Fedora dist I can see jq package has libjq library.

[safarov@safarov-dell tamu-lab]$ rpm -ql jq | grep libjq
/usr/lib64/libjq.so.1
/usr/lib64/libjq.so.1.0.4

I want use jq functionality from other program natively, without calling bash and serializing/deserializing json. I can see preent .h files

[safarov@safarov-dell tmp]$ rpm -ql jq-devel
/usr/include/jq.h
/usr/include/jv.h
/usr/lib64/libjq.so

But no documentation how to use functions in the library. Could you extend documentation of library calls?

sergey-safarov avatar Aug 07 '23 02:08 sergey-safarov

Yes, it would be nice to have manual pages for jv_*(), and other libjq public functions. ^^

emanuele6 avatar Aug 07 '23 02:08 emanuele6

Yes, I think we can start thinking about the stability of the jv and jq APIs now.

nicowilliams avatar Aug 07 '23 15:08 nicowilliams