Comments (4)
Remkus,
Thanks for getting in touch. I love the completions.
You mentioned WordPress coding standards. I see that certain snippets of mine do not adhere to the standards when it comes to minor things such as spacing around function params. If you fork my repo and apply your changes (as described below), I will merge it and edit my snippets to ensure they all adhere to wp coding standards.
The only issue I have is with the general WordPress snippets. I'd like to keep this repo specific to Genesis. There are other sublime packages for WordPress snippets and I like to keep the two separate.
If we merged these two repos I would prefer the following result...
Two directories - "snippets" and "completions"
Remove the WordPress directory
Put all of my snippets along with yours under the snippets folder
After you submit the pull request I will edit my snippets to make sure they all adhere to WP coding standards.
Let me know what you think.
from genesis.
That's exactly how I see it. I already contributed to the general WordPress snippet project here on Github and I planned to move out the WordPress snippets out of my project. So we're good :) Would be lovely if we could add proper DocBlocks to the functions instead of just the spacing, you know, set an example. More info here: http://remkusdevries.com/when-sharing-wordpress-related-code-snippets-i-can-haz-standards-please/
Might not get it done this week, since I'm getting ready to go to and speak at WordCamp Norway, but you'll see a proper pull request from me real soon :)
from genesis.
I will add DocBlocks to my snippets. I'd prefer leaving out things like @author and @link. If it does not help the reader understand the function then they probably don't want it in their code. @link would be ok if the function requires an explanation and the uri provides one beyond another copy of the function source code.
from genesis.
@author in this case perhaps only makes sense if it is concerning a function written by someone else and thus has the copyright. Most likely in that case the @link will be needed as well..
On Tuesday, 22 January, 2013 at 04:48 , Justin Tallant wrote:
I will add DocBlocks to my snippets. I'd prefer leaving out things like @author (https://github.com/author) and @link (https://github.com/link). If it does not help the reader understand the function then they probably don't want it in their code. @link (https://github.com/link) would be ok if the function requires an explanation and the uri provides one beyond another copy of the function source code.
—
Reply to this email directly or view it on GitHub (#1 (comment)).
from genesis.
Related Issues (2)
- Inconsistent prefixes HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from genesis.