Comments (7)
hm, good idea
from zubr.
@radmen ..?
from zubr.
...it might also make sense to always have the "NOTE" part, so even if the function didn't change from the original:
/**
* @link http://php.net/manual/en/function.xxx.php
*
* NOTE: no change
*/
from zubr.
Ok, my proposal - @link
tag for every function - but the functions with different order should use @param
tag - @nkkollaw what about that?
from zubr.
Yes, if functions have changes we have to document them with @param, @return if we return something different, etc.
I will create an example and put it in the CONTRIBUTING file.
from zubr.
I'd say that we should keep bare minimum:
- Short description - usually the first line from php.net (eg for
strstr
: Find the first occurrence of a string) - @param
- @return
- @link to docs on php.net
(sorry for late response, I'm still on vacation till end of week)
from zubr.
I'd say that we should keep bare minimum
I don't know if we have to document PHP's functions. I think it's more useful to describe what we change, since we expect our target to know what they're doing if they're using and feel the need for this kind of library.
Personally, I'm fine with @param etc. if they're already there (e.g., if adding them doesn't slow us down0, but the description I would along the lines of:
No change from original (see php.net/strstr)
or:
NOTE: we switched $haystack with $needle as per our guidlines
sorry for late response, I'm still on vacation till end of week
No problem!
from zubr.
Related Issues (20)
- Double-check Composer file
- `array_column` PSR2 errors
- Slack
- Zubr isn't bundled with PHP HOT 4
- Implement validator tool HOT 2
- Automate adding functions and tests HOT 11
- xxxx
- Add test for array_count_values()
- array_change_key_case() has wrong default value
- array_change_key_case() has wrong doc format
- array_chunk() has wrong doc format
- array_chunk() has wrong doc format HOT 1
- array_combine() has wrong doc format
- Add test for array_fill_keys()
- Add test for array_fill()
- Add test for array_flip()
- Add test for array_keys()
- Remove dist folder? HOT 6
- Add a performance readme entry HOT 1
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 zubr.