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.

Sign up for GitHub

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

Jump to bottom

Integration doc - use RTL signal names #570

Closed
wants to merge 1 commit into from
Closed

Integration doc - use RTL signal names #570

wants to merge 1 commit into from

Conversation

steven-bellock
Copy link
Contributor

Fix-up integration document so that the signal names match RTL.

Signed-off-by: Steven Bellock [email protected]

@steven-bellock steven-bellock marked this pull request as ready for review August 15, 2024 14:43
@steven-bellock
Integration doc - use RTL signal names
f449646 
Fix-up integration document so that the signal names match RTL.

Signed-off-by: Steven Bellock <[email protected]>
@steven-bellock
Copy link
Contributor Author

@calebofearth to run CI/CD and review.

calebofearth
calebofearth reviewed Sep 10, 2024
View reviewed changes
Copy link
Collaborator

@calebofearth calebofearth left a comment

Choose a reason for hiding this comment

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

Generally good changes, esp. capitalization updates to match RTL👍
The escapes on underscores are to prevent inadvertent italicization of text -- we've applied them inconsistently throughout this doc, so that's a separate issue, but it looks like this PR removes some of the escape characters. What was the motivation for that?

@steven-bellock
Copy link
Contributor Author

What was the motivation for that?

Italicization needs two _s within a word. If there's only one _ then it's fine without the escape character.

@calebofearth
Copy link
Collaborator

What was the motivation for that?

Italicization needs two _s within a word. If there's only one _ then it's fine without the escape character.

Okay, should we just remove them everywhere then? There are many instances of similar formatting over on Caliptra.md as well.
I'm not totally sure what the backstory is if it's not for preventing Markdown formats.

@Nitsirks Nitsirks mentioned this pull request Jan 28, 2025
Draft
@steven-bellock
Copy link
Contributor Author

Closing issue, as most of this is being taken care of in #713.

@steven-bellock steven-bellock deleted the fix-up-signals branch January 30, 2025 22:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@calebofearth calebofearth calebofearth left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@steven-bellock @calebofearth