Skip to content

Conversation

@PMunch
Copy link
Contributor

@PMunch PMunch commented Feb 28, 2020

jsondoc is meant to be read by computers, but yet the signatures of
procedures where simply a string of the whole thing. This adds a
signature object that unpacks this information into an object so it's
easier to analyse the documented signatures.

I will add a changelog entry and fix the documentation if this gets approved for merging.

jsondoc is meant to be read by computers, but yet the signatures of
procedures where simply a string of the whole thing. This adds a
signature object that unpacks this information into an object so it's
easier to analyse the documented signatures.
@Araq
Copy link
Member

Araq commented Feb 28, 2020

Well I have no overview over what kind of tooling relies on "jsondoc".

@timotheecour
Copy link
Member

timotheecour commented Mar 2, 2020

maybe not much so far because jsondoc hasn't been given much attention, but it would be useful for tooling to read nim generated docs (eg IDE's, cmd line tools) ; #9462 and #8495 are relevant

@PMunch
Copy link
Contributor Author

PMunch commented Mar 2, 2020

I haven't seen anything that uses this. What I wanted to do was to automatically generate tests based on the documentation to check a claim I make. This is also completely backwards compatible, I haven't removed any fields from the JSON, just added new ones.

@Araq Araq merged commit 05e9473 into nim-lang:devel Mar 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants