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

minor changes to sway.5.scd #7088

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

minor changes to sway.5.scd #7088

wants to merge 3 commits into from

Conversation

quinnyo
Copy link
Contributor

@quinnyo quinnyo commented Jun 26, 2022

A couple of minor changes to the hide_edge_borders description.

  • now refers to the correct smart_borders option ('smart' -> 'on')

  • more consistent use of emphasis

A couple of minor changes to the hide_edge_borders description.

- now refers to the correct smart_borders option ('smart' -> 'on')

- more consistent use of emphasis
@kennylevinsen
Copy link
Member

Does this still render correctly through scdoc? The underscore sequence does look like something that could break it (_on_|_no_gaps_)...

@quinnyo
Copy link
Contributor Author

quinnyo commented Jun 27, 2022

It seems to be fine, I borrowed the syntax from the line above (and elsewhere in the file) as I was unsure myself. Diffing the output from scdoc gives:

1086,1087c1086,1087
< options are equivalent to setting \fIsmart_borders\fR smart|no_gaps and
< \fIhide_edge_borders\fR none.\&
---
> options are equivalent to setting smart_borders \fIon\fR|\fIno_gaps\fR and
> hide_edge_borders \fInone\fR.\&

@emersion
Copy link
Member

Ideally the whole command ("smart_borders on|no_gaps") should be underlined I think?

@quinnyo
Copy link
Contributor Author

quinnyo commented Jun 27, 2022

I don't know. I just looked around the file to see how it was done.
Almost every underlined bit of text is a parameter.
There are a lot of mentions of commands without any markers.
I think there are more commands in bold than underlined, not including the ones used as headings.

@emersion
Copy link
Member

Bold is used for command definitions. Underline is used for references.

@quinnyo
Copy link
Contributor Author

quinnyo commented Jul 2, 2022

Hi, hopefully that's OK now! Apologies for generating so much back and forth over this 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants