search

amphp / beanstalk

Asynchronous Beanstalk Client for PHP.
https://amphp.org/beanstalk/
MIT License
66 stars 24 forks source link

Update documentation for the package #16

Closed hskrasek closed 6 years ago

hskrasek commented 6 years ago

As the title says, working on updating the documentation for the package to try and bring it in line with the other packages.

Signed-off-by: Hunter Skrasek hunterskrasek@me.com

hskrasek commented 6 years ago

Currently a work in progress, just wanted to open early so that people can catch any spelling mistakes or weird grammar screw ups.

hskrasek commented 6 years ago

@kelunik I'm down with that. I was mainly just mirroring how the aerys package has its classes documented. Do you think we should document the Connection and Parser classes? BeanstalkClient will get documented once I finish adding examples for the other methods.

hskrasek commented 6 years ago

Fyi, still gonna finish this, just got tied up the past couple of days. Soon though! Soon

hskrasek commented 6 years ago

@kelunik If I wanted to see how these docs look locally, whats the best way? I got Jeykll running locally but if I start it up within the docs directory everything just comes out unstyled.

kelunik commented 6 years ago

@hskrasek See https://github.com/amphp/amphp.github.io#setup-for-an-existing-repository

hskrasek commented 6 years ago

@kelunik Sorted out the integer vs int issue. Sorry this is taking so long, wanna add a couple of pages about working with jobs and tubes. Haven't directly worked with some of the commands though, so been studying up on the protocol.

Might actually throw together some integration tests (and submit those separately) to make sure my examples make sense. Hope to have this finished up for you soon though

hskrasek commented 6 years ago

Alright I'm sure some wording needs to be adjusted all over the place, but I think I've got just about everything documented with examples.

kelunik commented 6 years ago

Should I merge this now or do you plan further changes?

hskrasek commented 6 years ago

@kelunik Hmm I can't think of anything else to add at the moment. Noticed some missing methods from the client that exist in the beanstalk spec, but I'll document those when I get around to PRing them (unless someone else beats me to it).

I think we're all good here

kelunik commented 6 years ago

@hskrasek Could you open issues for the missing methods?

Thanks for your contribution!