Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

manual: use/repl-script: add details about the REPL and Script interfaces, along with examples #446

Merged
merged 2 commits into from
Oct 21, 2023

Conversation

attie
Copy link
Member

@attie attie commented Oct 20, 2023

Finally, some words around using the REPL and script interfaces... I've included I2C, UART and WS2812 demos... I'll happily have a rummage for an SPI device to add that if it's deemed important.

@attie attie added the documentation Component: documentation label Oct 20, 2023
@whitequark
Copy link
Member

Style nit: do you think you can use em-dashes? This is currently inconsistent across the manual and it's bugging me. (We could use that being a part of our documentation style guide.)

Other than that the main high-level feedback I have is that I'm not sure if tabs are the right thing here.

@attie
Copy link
Member Author

attie commented Oct 20, 2023

do you think you can use em-dashes?

Sure.

We could use that being a part of our documentation style guide

I'll add it, along with a handy "copy me" example. 🙃

I'm not sure if tabs are the right thing here.

I'll change for sub-headings... my only thought was that it becomes quite a long page.
I think due to this I'm less inclined to add many more examples if they're not tabs... thoughts?

@whitequark
Copy link
Member

I'll change for sub-headings... my only thought was that it becomes quite a long page.

I do see that but tabs are an accessibility concern here. The idea with tabs is that you do not need the other items, period (like if they're on an OS that does not concern you); not that you do not need other items at the same time.

@whitequark
Copy link
Member

I'll add it, along with a handy "copy me" example. 🙃

You can just use --- I think--you don't actually need to use the — symbol.

@attie
Copy link
Member Author

attie commented Oct 20, 2023

I do see that but tabs are an accessibility concern here.

Yeah, I was back and forth with that being one of the arguments.

Copy link
Member

@whitequark whitequark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Style guide looks good. For the rest I will go with a "post-merge review": I merge this now and then later, when I have more uninterrupted time, we can look closer again (possibly together!) and work out if more improvement can be made.

@whitequark whitequark added this pull request to the merge queue Oct 21, 2023
Merged via the queue into GlasgowEmbedded:main with commit 3f802df Oct 21, 2023
10 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Component: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants