search

gabrielcsapo / node-git-server

🎡 A configurable git server written in Node.js
https://gabrielcsapo.github.io/node-git-server
MIT License
253 stars 73 forks source link

documentation and initial tests for duplexing lib #25

Closed echopoint closed 6 years ago

echopoint commented 6 years ago

This should help on issue #6 and #17 and document the HttpDuplex class. This can sit and wait for other docs to be wrapped into the next release as well.

gabrielcsapo commented 6 years ago

@echopoint is this good to go? :) I will generate the JSdoc when this gets merged. I have some code waiting to be submitted, just keep getting side tracked.

echopoint commented 6 years ago

should be.. and no worries just throwing stuff in when I get the time/chance

gabrielcsapo commented 6 years ago

docs updated and pushed @echopoint https://www.gabrielcsapo.com/node-git-server/code/HttpDuplex.html

echopoint commented 6 years ago

Yup looks, ok, Only thing I noticed working on that doc is multiple '@see' references in the comments don't line up, but eh, on the grand scale o' things that's ok atm.

gabrielcsapo commented 6 years ago

@echopoint is that a css bug? can you screenshot and post here?

echopoint commented 6 years ago

Most likely a css 'bug' since the html generated is basic and the links are just links inside of a ul. It's minor, and on every doc section that has multiple lines in the see section.

screenshot 1 jpg

gabrielcsapo commented 6 years ago

ohhh, yeah it is a bug, the see tag has a fixed width.

screen shot 2017-11-08 at 9 21 31 pm

echopoint commented 6 years ago

Looks to me because see is float: left causes the issue. If the block the label was in was a hard left block vertically spanning a full column, the problem would go away and it would align up.

see-floating-left2 jpg

gabrielcsapo commented 6 years ago

simply removing this arbitrary width seems to fix the problem, I don't now if this was purposeful as it seems to align things specifically with the intention of only one see existing at a time.

screen shot 2017-11-08 at 9 54 22 pm

echopoint commented 6 years ago

Simpler is always better. So fine with me. I'll get around to looking at the css for the theme in a couple of days. ;) Definitely prefer that over table-cell hack for .details dd and .details dt

gabrielcsapo commented 6 years ago

I submitted a quick PR, it seems unmaintained but hoping for the best.

echopoint commented 6 years ago

bah, been a year.. may have to pull an actionhero there but we'll see.

gabrielcsapo commented 6 years ago

could switch templates https://github.com/nijikokun/minami, I have used this before. Or what if we just don't have a theme?

screen shot 2017-11-08 at 10 15 43 pm screen shot 2017-11-08 at 10 15 38 pm

echopoint commented 6 years ago

Out of the two I'd probably pick minami as plan b. Themes don't get much attention once they're in the wild.

gabrielcsapo commented 6 years ago

@echopoint so you are saying stick with no theme? (the pictures above represent default theming)

echopoint commented 6 years ago

I'm fine with any of the choices really. It's documentation. Readability is king there, and they are all readable. I'm a fairly simple person in that respect. The final answer is ultimately up to you. ;)

gabrielcsapo commented 6 years ago

Okay let me fix up my jsdoc's in the other parts of the code, send a PR and we can flip a coin 😄