search

mrdavidlaing / pressupbox-development-boilerplate

Patterns and practices for teams to collaborating on WordPress projects
Other
1 stars 5 forks source link

Documentation & IDE code completion #25

Closed mrdavidlaing closed 11 years ago

mrdavidlaing commented 11 years ago

Extracted from #22

In wordphing there's phing wp-doc, this gave me the idea of providing phpdocs of the current core files. Finally phpdoc released phpDocumentor2, in fact we may not even need phing, but will require pear and a rake task to build the docs.

The documentation could be served at: http://localhost:4567/docs If in future releases we allow the dev to change the core then a script inside the vm could be run to rebuild it (phpdocs) - maybe a ruby script http://localhost:4567/docs/build.rb (would then call rake:task_build_docs)

My research of netbeans makes it unfeasible to provide code hints and couldn't find option to reference core files outside of project folder. Here is there code completion tutorial Netbeans Code Completion Also to note the phpdoc suggestion allows reference to project and core files for all dev's - IDE independant

daithi-coombes commented 11 years ago

when a pull request is created from an issue, should we close the issue - as all debate will then move to the pr.

ryanholder commented 11 years ago

Yes I think this is the right way, I believe that is the way it takes place if you use hub

On 15 April 2013 16:12, daithi-coombes notifications@github.com wrote:

when a pull request is created from an issue, should we close the issue - as all debate will then move to the pr.

— Reply to this email directly or view it on GitHubhttps://github.com/mrdavidlaing/pressupbox-development-boilerplate/issues/25#issuecomment-16387052 .

mrdavidlaing commented 11 years ago

Yes; we want discussion to move into the PR. You can either:

  1. Use hub to convert the issue to a PR.
  2. Close the issue with a reference to the new PR.
mrdavidlaing commented 11 years ago

Conversation moved to #28