Tutorial code samples should show which lines have been added and explicitly mention the file
schontz opened this issue · comments
David Schontzler commented
For example, in the (theming tutorial)[https://dojo.io/tutorials/007_theming/] you have the following:
So for worker.m.css, you need to add the import for the worker.m.css and the theme itself to the exported object using the key biz-e-corp/worker.
import * as textInput from './@dojo/widgets/text-input/text-input.m.css';
import * as button from './@dojo/widgets/button/button.m.css';
import * as worker from './worker.m.css';
export default {
'@dojo/widgets/button': button,
'@dojo/widgets/text-input': textInput,
'biz-e-corp/worker': worker
};
-
In this sample it is never mentioned that the file to be edited is
theme.ts
(I believe the firstworker.m.css
was meant to betheme.ts
). It would be ideal if every code block had the relative path of each file being edited for quick reference. -
Also, only 2 lines have been added and one line has been edited. It would be best to show the user which changes have been made.
Attached is a very rough sample of what it could look like (minus line numbers and collapsing).
David Schontzler commented
Fixed in #444