PragProg Customers

Design and Build Great Web APIs: What does “human readable documentation available in the book’s source code.” mean?

jeffmcompsci

jeffmcompsci

Design and Build Great Web APIs: What does “human readable documentation available in the book’s source code.” mean?

On page 9, it talks about “human readable documentation available in the book’s source code.” What is meant by this? Does that mean the two files activity-list.js and activity-record.js under /ch01-apifirst? This is unclear and I do not see any other form of what could be considered human-readable documentation in the book’s source code.

Thank you,

Jeff

1 comment
/book-design-and-build-great-web-apis
5 770 1

Most Liked

mamund

mamund

Author of Design and Build Great Web APIs

yes. i need to point to the services folder that has the source for all the pre-existing services. i’ll fix that. --mamund

1
Post #2

Popular Prag Prog topics Top

duke_meister
PragProg Customers

The Ray Tracer Challenge - where are the errata?
As per the title, thanks.
/book-the-ray-tracer-challenge
6 1671 4
New
Razor54672
PragProg Customers

Practical Programming, Third Edition: Incorrect Answer in Chapter 5 Exercise Solution
The answer to 3rd Problem of Chapter 5 (Making Choices) of “Practical Programming, Third Edition” seems incorrect in the given answer ke...
#errata/book-practical-programming-third-edition
2 1040 0
New
jamis
PragProg Customers

The Ray Tracer Challenge: various errata
The following is cross-posted from the original Ray Tracer Challenge forum, from a post by garfieldnate. I’m cross-posting it so that the...
#errata/book-the-ray-tracer-challenge
4 2350 3
New
mikecargal
PragProg Customers

Hands-on Rust: can_place logic is "inside out"
Title: Hands-On Rust (Chapter 11: prefab) Just played a couple of amulet-less games. With a bit of debugging, I believe that your can_p...
#errata/book-hands-on-rust
22 1619 20
New
edruder
PragProg Customers

Docker for Rails Developers: Notes for Rails 6.1, Ruby 2.7.2
I thought that there might be interest in using the book with Rails 6.1 and Ruby 2.7.2. I’ll note what I needed to do differently here. ...
/book-docker-for-rails-developers
9 1171 1
New
Mmm
PragProg Customers

Hands-on Rust: Build depending on bracket-lib fails
Hi, build fails on: bracket-lib = “~0.8.1” when running on Mac Mini M1 Rust version 1.5.0: Compiling winit v0.22.2 error[E0308]: mi...
#question/book-hands-on-rust
1 1214 1
New
frasette
PragProg Customers

A Common-Sense Guide to Data Structures and Algorithms, Second Edition: erroneous extra space complexity (page400)
A Common-Sense Guide to Data Structures and Algorithms, Second Edition by Jay Wengrow @jaywengrow Hi, I have the paperback version of t...
#errata/book-a-common-sense-guide-to-data-structures-and-algorithms-second-edition
4 1180 2
New
jonmac
PragProg Customers

Kotlin and Android Development featuring Jetpack: allprojects should be moved to settings.gradle (page 245)
The allprojects block listed on page 245 produces the following error when syncing gradle: “org.gradle.api.GradleScriptException: A prob...
#suggestion/book-kotlin-and-android-development-featuring-jetpack
1 2221 1
New
s2k
PragProg Customers

Agile Web Development with Rails 7: Reloading assets in development mode
Hi all, currently I wonder how the Tailwind colours work (or don’t work). For example, in app/views/layouts/application.html.erb I have...
#question/book-agile-web-development-with-rails-7
2 1376 4
New
SlowburnAZ
PragProg Customers

Machine Learning in Elixir:Error installing EXLA dependency - Page 25
Getting an error when installing the dependencies at the start of this chapter: could not compile dependency :exla, "mix compile" failed...
/book-machine-learning-in-elixir#errata
1 1057 10
New

Other popular topics Top

AstonJ
Hardware

Seen any cool new keyboards?
We have a thread about the keyboards we have, but what about nice keyboards we come across that we want? If you have seen any that look n...
/keyboards#mechanical-keyboards
44 5023 35
New
PragmaticBookshelf
Game Developer Forum>Learning Resources

Hands-on Rust: Effective Learning through 2D Game Development and Play
Rust is an exciting new programming language combining the power of C with memory safety, fearless concurrency, and productivity boosters...
#pragprog/rust#published-book/book-hands-on-rust
118 7074 30
New
AstonJ
Backend Developer Forum>Questions/Help

Erlang's not installing on macOS Big Sur "You are natively building Erlang/OTP for a later version of MacOSX than current version"
Just done a fresh install of macOS Big Sur and on installing Erlang I am getting: asdf install erlang 23.1.2 Configure failed. checking ...
/erlang#asdf#macos#big-sur
10 5387 8
New
PragmaticBookshelf
In The Spotlight

Spotlight: Noel Rappin (Author)
“Finding the Boundaries” Hero’s Journey with Noel Rappin @noelrappin Even when you’re ultimately right about what the future ho...
#author-spotlight#web-development/rails/book-modern-front-end-development-for-rails/book-rails-5-test-prescriptions
34 3654 21
New
foxtrottwist
General Dev Chat

Warp—The blazingly fast, Rust-based terminal
A few weeks ago I started using Warp a terminal written in rust. Though in it’s current state of development there are a few caveats (tab...
/rust#terminal
52 4610 22
New
PragmaticBookshelf
In The Spotlight

Spotlight: Erin Dees (Author) Interview and AMA!
Author Spotlight Erin Dees @undees Welcome to our new author spotlight! We had the pleasure of chatting with Erin Dees, co-author of ...
#author-spotlight/ruby/rails/book-effective-testing-with-rspec-3#rspec#book-seven-moreuages-in-seven-weeks/book-cucumber-recipes
24 3446 11
New
First poster: CommunityNews
In The News

How to fix the eyes in AI-generated images
aidemos.info
0 2738 0
New
PragmaticBookshelf
In The Spotlight

Spotlight: Karl Stolley (Author) Interview and AMA!
Author Spotlight: Karl Stolley @karlstolley Logic! Rhetoric! Prag! Wow, what a combination. In this spotlight, we sit down with Karl ...
#author-spotlight/book-programming-webrtc
31 3552 16
New
PragmaticBookshelf
In The Spotlight

Spotlight: Peter Ullrich (Author) Interview and AMA!
Author Spotlight: Peter Ullrich @PJUllrich Data is at the core of every business, but it is useless if nobody can access and analyze ...
/elixir/phoenix/book-building-table-views-with-phoenix-liveview
72 3720 21
New
CommunityNews
In The News

X can’t stop spread of explicit, fake AI Taylor Swift images
Will Swifties’ war on AI fakes spark a deepfake porn reckoning?
arstechnica.com
/swift
0 5684 0
New
Back to top

Latest in PragProg

Agile Web Development with Rails 8 B7.0: order_mailer_test failing (page 196)
PragProg Customers
Simplicity: Let’s Change Our World — Again
PragProg Customers
Simplicity: "detail"→"derail" (page 74, B2.0)
PragProg Customers
Agile Web Development with Rails 8: Page 9
PragProg Customers
Kotlin Coroutine Confidence: Code does not run (pg 225)
PragProg Customers
Agile Web Development with Rails 8 B7.0: partials folder (page 151)
PragProg Customers
Kotlin Coroutine Confidence: Change function name, maybe (pg 182)
PragProg Customers
Modern Front-End Development for Rails, Second Edition: can't get code to run
PragProg Customers
Kotlin Coroutine Confidence: Book & source code do not match (pg 180)
PragProg Customers
Kotlin Coroutine Confidence: Add formatter off/on comments (pg 162)
PragProg Customers
Kotlin Coroutine Confidence: What's the IntelliJ IDEA inspection? (pg 133 & 141)
PragProg Customers
Kotlin Coroutine Confidence: Add `parallel/v9` (pg 125)
PragProg Customers
Agile Web Development with Rails 8_B7.0 (pages 93/94)
PragProg Customers
Agile Web Development with Rails 8_B7.0 (page 93)
PragProg Customers
Agile Web Development with Rails 8_B7.0 (page 90)
PragProg Customers
Programming Phoenix LiveView: Awkward sentence/missing word (page 67)
PragProg Customers
Kotlin Coroutine Confidence: Add location indicators to output (pg 80)
PragProg Customers
Kotlin Coroutine Confidence: Confusing Sentence (pg 78)
PragProg Customers
Kotlin Coroutine Confidence: Formatting issue PDF (pg 78-79)
PragProg Customers
Programming Phoenix LiveView: remove <br /> from examples (page 18)
PragProg Customers

View all threads ❯

Latest (all)

Why Flatpak Apps Use So Much Disk Space On Linux - OSTechNix
Linux In The News
Dummy's Guide to Modern Samplers
In The News
openSUSE: Upgrade to Freedom Campaign Shifts to End of 10
Linux News (official)
Design for 3D-Printing - Rahix' Blog
In The News
Orders of infinity
In The News
Functional HTML — overreacted
In The News
I made a cafe relax game, a browser game
Game Dev Chat/Discussions
Progressive Dehancement
In The News
A DOGE recruiter is staffing a project to deploy AI agents across the US government
In The News
Chips aren’t improving like they used to, and it’s killing game console price cuts
In The News
Fable 5.0.0-alpha.13 released!
Frontend News
Part 1: How We Fell Out of Love with Next.js and Back in Love with Ruby on Rails & Inertia.js - Hardcover Blog
In The News
DuckDB is Probably the Most Important Geospatial Software of the Last Decade
In The News
You Sent the Message. But Did You Write It?
In The News
Speedrunning and Modding The Incredibles: Rise of the Underminer
In The News

View all threads ❯

We ❤️ helpful members!

We reward our most helpful members via our MOTM scheme - by giving away a whopping 25 books per year!

Member of the Month

Devtalk Sponsors

Pragmatic Bookshelf

Practical resources that improve the lives of professional developers.

Erlang Solutions

We build trusted fault-tolerant systems that scale to billions of users.

Manning Publications

Develop your skills with books, videos, and courses.

AppSignal

Catch errors, track performance, monitor hosts and more.

WyeWorks

Enabling companies to succeed by building software people love.

Pragmatic Studio

Courses that'll move you from confusion to "Aha, now I get it!"

View all our sponsors ❯

Categories:

Popular Portals

Devtalk Sponsors

Pragmatic Bookshelf

Practical resources that improve the lives of professional developers.

Erlang Solutions

We build trusted fault-tolerant systems that scale to billions of users.

Manning Publications

Develop your skills with books, videos, and courses.

AppSignal

Catch errors, track performance, monitor hosts and more.

WyeWorks

Enabling companies to succeed by building software people love.

Pragmatic Studio

Courses that'll move you from confusion to "Aha, now I get it!"

View all our sponsors ❯

We're in Beta

About us Mission Statement See our Roadmap