inch-ci / inch_ci-web

Web frontend for Inch CI
http://inch-ci.org/
MIT License
139 stars 20 forks source link

no docs are shown #93

Closed sagiegurari closed 9 years ago

sagiegurari commented 9 years ago

For some reason it can't find the jsdocs for my new repo: sagiegurari/multiple-redis

Re: sagiegurari/multiple-redis

sagiegurari commented 9 years ago

any updates on this one? the doc workers seem to be stuck.

rrrene commented 9 years ago

D'oh! I typed the following two days ago and left the tab open without submitting. Sorry!


Clearly a bug in the CI system. If we run the CLI client, we get the following result:

$ inchjs list

# Seems really good                                                             
┃  A  →  MultiRedisClient.createClient in /lib/multiple-redis.js
┃  A  →  MultiRedisClient.createClient in /lib/multiple-redis.js
┃  A  →  MultiRedisClient in /lib/multiple-redis.js
┃  A  ↓  MultiRedisClient in /lib/multiple-redis.js

$ inchjs suggest

Nothing to suggest. Try --pedantic to be excessively concerned with minor details and rules.

But Inch CI somehow is stuck in the evaluation worker. Will try to figure this out this weekend! :+1:

sagiegurari commented 9 years ago

Thanks a lot

rrrene commented 9 years ago

TL;DR I will have to release a version of InchJS that supports multiple signatures per function.

Okay, I figured it out, but this will take a bit of work on my part.

The "problem" is this line: https://github.com/sagiegurari/multiple-redis/blob/a79387a6dd0b919ddca24663ac61c548f1130ed7/lib/multiple-redis.js#L238

InchJS does not (yet) know how to handle multiple signatures per function. JSDoc (which is used for parsing the docs) creates two functions in its output for MultiRedisClient.createClient which in turn freaks out the CI service since there can't be two functions with the same identifier inside the same project.

sagiegurari commented 9 years ago

ok got you. basically that's the jsdoc way of documenting overloaded functions. surprised it hasn't shown up on any other repo until now.

sagiegurari commented 9 years ago

any updates on this one?

rrrene commented 9 years ago

Yep, it's done. Sorry this took so long: https://inch-ci.org/github/sagiegurari/multiple-redis

sagiegurari commented 9 years ago

Thanks a lot