Seems to miss most of our JavaScript

inch-ci / inch_ci-web

Web frontend for Inch CI

http://inch-ci.org/

MIT License

139 stars 20 forks source link

Seems to miss most of our JavaScript #86

Open ylg opened 9 years ago

ylg commented 9 years ago

Perhaps the code in client/** is missed because it's ES6, but the code in server/** is ES5. Virtually none of it's documented (yet!) and Inch CI seems to only be calling out one function as having proper documentation (incorrect) and one function as missing documentation (correct.) There's just few more than two functions in this code base. :smile:

My first guess would that inch.json is wrong, but clearly server/\ is being found…

Re: sensedata/space-telemetry

rrrene commented 9 years ago

Hi there, sorry for the late reply.

There was a bug in the worker, now it should be "more complete". Like you pointed out, InchJS is still not capable of parsing the ES6 parts:

http://inch-ci.org/github/sensedata/space-telemetry

Thanks for your bug report!

julkue commented 8 years ago

@rrrene If it's not compatible with all ECMAScript versions (especially ES6) then please correct the following sentence on the website as it indicates that it is fully compatible with JS:

Documentation badges for Ruby, JS & Elixir

Documentation badges for Ruby, JS < ES6 & Elixir

Also the following informations are missing on the website:

What documentation generator syntax can be used, described in https://github.com/rrrene/inchjs#features
What server is running behind the scenes to handle badge requests. This is important, because users like me that already have bad experiences with open source services like isitmaintained.com or issuestats.com will not use your service without this information.

rrrene commented 8 years ago

@julmot Thanks :+1:

Could you elaborate on what you mean by the last point? ("What server is running behind the scenes")

julkue commented 8 years ago

@rrrene I've previously used e.g. issuestats.com, isitmaintained.com, shields.io, etc. and was disappointed. They are offering badges that may be helpful for users, but they don't have the necessary server architecture to run such a service. They are down daily (see e.g. https://github.com/hstove/issue_stats/issues/41) and therefore I needed to remove them partially. So if you want to win users like me, you definitely need to provide information about availability/downtime. If you know you have a great service but aren't able to finance it, I'm sure we would find backers (e.g. GitHub or private OSS users).

rrrene commented 8 years ago

Ah! Thanks for the explanation. :+1: