Commit ba9d770
committed
docs: fix stale README + guides — plural factories, V3 object-init, real PhysicalConstants surface
Sweeps three user-facing docs to match the current generator output:
README.md
- V0 factory examples already correct on plural (FromMetersPerSecond,
FromMeters, FromKilograms, FromNewtons, FromSeconds).
- V3 examples (Force3D, Displacement3D) switched from non-existent
3-arg From{Unit}(x, y, z) factories to object-initializer
construction with X/Y/Z components, which matches what the
generator actually emits.
- Magnitude() example now says "Length" rather than "Distance" — the
V3 base's Magnitude() returns the V0 base of the dimension, not an
overload.
- Added a comment showing the construction-time invariants from
#50/#51 (Speed.FromMetersPerSecond(-1) and
Wavelength.FromMeters(0) both throw ArgumentException).
- Removed the aspirational PhysicalConstants.Conversion.X<T>()
examples (CLAUDE.md was already cleaned up in #70 but README
hadn't been). Replaced with the real domain-grouped /
Generic<T>() shape that PhysicalConstantsGenerator emits today.
- Architecture section: now lists units.json/magnitudes.json/
conversions.json/domains.json alongside dimensions.json and adds
the SEM001/SEM002/SEM003 diagnostic line-up.
docs/physics-domains-guide.md
- Magnitude / Cross / Dot examples use object-initializer for V3,
matching the generated surface.
docs/complete-library-guide.md
- Same V3 fix.
- "mass * Acceleration<double>.FromMeters(9.8)" was nonsense on two
counts (Acceleration is a dimension name, not a generated type;
Meters is the wrong unit for acceleration). Replaced with the
correct AccelerationMagnitude<double>.FromMetersPerSecondSquared(9.8).
- Magnitude() example now says "Length" rather than "Distance"; same
reason as the README fix.
No code or generated output changes; pure docs sync to current API.1 parent f41624b commit ba9d770
3 files changed
Lines changed: 51 additions & 35 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
99 | 99 | | |
100 | 100 | | |
101 | 101 | | |
102 | | - | |
| 102 | + | |
103 | 103 | | |
104 | | - | |
105 | | - | |
| 104 | + | |
| 105 | + | |
106 | 106 | | |
107 | | - | |
108 | | - | |
109 | | - | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
110 | 110 | | |
111 | 111 | | |
112 | | - | |
113 | | - | |
| 112 | + | |
| 113 | + | |
114 | 114 | | |
115 | 115 | | |
116 | 116 | | |
117 | 117 | | |
118 | | - | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
119 | 123 | | |
120 | 124 | | |
121 | | - | |
| 125 | + | |
122 | 126 | | |
123 | 127 | | |
124 | 128 | | |
125 | 129 | | |
126 | 130 | | |
127 | | - | |
| 131 | + | |
128 | 132 | | |
129 | 133 | | |
130 | 134 | | |
131 | | - | |
| 135 | + | |
132 | 136 | | |
133 | 137 | | |
134 | 138 | | |
135 | | - | |
| 139 | + | |
136 | 140 | | |
137 | 141 | | |
138 | | - | |
139 | | - | |
140 | | - | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
141 | 149 | | |
142 | 150 | | |
143 | 151 | | |
| |||
161 | 169 | | |
162 | 170 | | |
163 | 171 | | |
164 | | - | |
| 172 | + | |
165 | 173 | | |
166 | 174 | | |
167 | | - | |
168 | | - | |
169 | | - | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
170 | 184 | | |
171 | 185 | | |
172 | 186 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
152 | 152 | | |
153 | 153 | | |
154 | 154 | | |
155 | | - | |
156 | | - | |
157 | | - | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
158 | 158 | | |
159 | 159 | | |
160 | 160 | | |
| |||
163 | 163 | | |
164 | 164 | | |
165 | 165 | | |
166 | | - | |
167 | | - | |
168 | | - | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
169 | 169 | | |
170 | 170 | | |
171 | | - | |
172 | | - | |
173 | | - | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
174 | 174 | | |
175 | 175 | | |
176 | 176 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
46 | | - | |
| 46 | + | |
| 47 | + | |
47 | 48 | | |
48 | 49 | | |
49 | 50 | | |
| |||
165 | 166 | | |
166 | 167 | | |
167 | 168 | | |
168 | | - | |
| 169 | + | |
169 | 170 | | |
170 | 171 | | |
171 | 172 | | |
172 | 173 | | |
173 | 174 | | |
174 | 175 | | |
175 | | - | |
176 | | - | |
| 176 | + | |
| 177 | + | |
177 | 178 | | |
178 | 179 | | |
179 | 180 | | |
180 | 181 | | |
181 | 182 | | |
182 | 183 | | |
183 | | - | |
184 | | - | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
185 | 187 | | |
186 | 188 | | |
187 | 189 | | |
| |||
0 commit comments