Skip to content
This repository has been archived by the owner on Sep 15, 2022. It is now read-only.

Docblocks for IDEs #143

Open
Nek- opened this issue Apr 13, 2015 · 5 comments
Open

Docblocks for IDEs #143

Nek- opened this issue Apr 13, 2015 · 5 comments
Assignees

Comments

@Nek-
Copy link
Contributor

Nek- commented Apr 13, 2015

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
Copy link

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

@Nek-
Copy link
Contributor Author

Nek- commented Mar 27, 2017

@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 :) .

@Nek- Nek- self-assigned this Mar 27, 2017
@Einenlum
Copy link

👍

@akerouanton
Copy link
Contributor

@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-
Copy link
Contributor Author

Nek- commented Jun 13, 2017

@NiR- you can go. I'm currently focused on #208 (which is complicated when you need to not break everything x.x)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants