Docblocks for IDEs - Githubissues

KnpLabs / FriendlyContexts

Some Behat contexts

MIT License

159 stars 66 forks source link

Docblocks for IDEs #143

Open Nek- opened 9 years ago

Nek- commented 9 years ago

Hello,

I know you dislike that, but it would be very useful for many people. I can handle it but I want you to tell me what you think about before doing anything.

Proposal:

No docblock for inherited method
No docblock for constructor (unless there is a crutial need)
No docblock for simple private/protected methods

See ya!

Einenlum commented 7 years ago

@Nek- I personally don't see any problem adding some dockblocks :)

Nek- commented 7 years ago

@Einenlum I was about to send a PR for this. :)

I'll also add the docblocks guidelines to the CONTRIBUTING.md (to avoid any future frustration for a contributor). So please tell me if there is any problem with that :) .

Einenlum commented 7 years ago

:+1:

akerouanton commented 7 years ago

@Nek- Besides auto-completion and other nice features from IDEs, the lack of docblocks is a pain in the ass when we've to use a method/property from one of the FriendlyContexts. Have you got some time to fix this issue? I can handle it, if you want.

Nek- commented 7 years ago

@NiR- you can go. I'm currently focused on https://github.com/KnpLabs/FriendlyContexts/issues/208 (which is complicated when you need to not break everything x.x)