Comments (2)
I intentionally omitted such documentation. The Ruby headers are just too big: the resulting documentation would be massive and difficult to maintain as Ruby evolves.
And, for the most part, that stuff is easy to look up if you know how to look for it (which is what my guide intends to teach you). For example, look up the documentation for Hash#[] and click the source: it shows you that the internal call is rb_hash_aref
and how the parameters are used. The amount of value added by including such documentation in my guide doesn't seem worth it considering the work involved.
If you feel up to the task, I'd say make your own separate documentation project. Let me know about it and I will happily link to it from my guide.
from emberb.
Ah ok. I'm considering adding it to the official ruby docs on ruby-doc.org.
See this issue: https://bugs.ruby-lang.org/issues/15074
from emberb.
Related Issues (20)
- "gaping whole" should be "gaping hole"
- LICENSE file HOT 1
- Explain how to build an extension with CMake HOT 4
- Problem while running Ruby code from C HOT 3
- How should I do the translation HOT 1
- How to handle malloc error? HOT 1
- How writing dup() HOT 1
- Data_Wrap_Struct is deprecated HOT 1
- Add allocation section HOT 1
- Document string encoding functions
- Document all basic types operations in table form HOT 1
- Document interfacing with complex numbers HOT 1
- Typos and small errors
- rb_cData is deprecated HOT 1
- Missing link for "when" in The Ruby C API HOT 1
- `ruby_options` no longer optional in 3.2? HOT 1
- Great job, thank you! HOT 1
- Problem with Time class
- Update to 3.3
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 emberb.