Skip to content

Wrong formatted syntax in all string functions #270

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

Closed
SeppPenner opened this issue Apr 28, 2019 · 4 comments
Closed

Wrong formatted syntax in all string functions #270

SeppPenner opened this issue Apr 28, 2019 · 4 comments
Assignees
Labels

Comments

@SeppPenner
Copy link
Collaborator

grafik

@SeppPenner SeppPenner added the bug label Apr 28, 2019
@SeppPenner SeppPenner self-assigned this Apr 28, 2019
@per1234
Copy link
Collaborator

per1234 commented May 3, 2019

I noticed that too. Some of these were fixed in the reference-en repository, but I think they went the wrong way by removing the backticks and leaving the code fences, contrary to the standard established by the sample reference page.

I was going to cherry pick those commits to this repository, but then I thought that I wouldn't bother and instead wait for it to be fixed properly when arduino/reference-en#559 is merged. I'm not sure how long it will be before that happens, so it might make sense to go ahead and fix the issue right away instead of waiting.

@SeppPenner
Copy link
Collaborator Author

SeppPenner commented May 3, 2019

I will check this and try to provide a fix. I'm not completely sure what the problem is there, however. I mean, the "`" should be automatically rendered as code, shouldn't it?

@per1234
Copy link
Collaborator

per1234 commented May 3, 2019

Ah, I misspoke, I was thinking of the same problem as it occurs in the "Characters" functions:
https://www.arduino.cc/reference/de/language/functions/characters/isalphanumeric/

Clipboard01

Here's the pull request that "fixed" those functions in the reference-en repository: arduino/reference-en#471

However, the fix was to remove the backquotes and leave the code fencing like this:

[source,arduino]
----
isAlphaNumeric(thisChar)
----

which renders like this:

isAlphaNumeric(thisChar)

However, if you look at the sample reference page, you can see that the code fencing should have been removed and the backquotes left instead:

`isAlphaNumeric(thisChar)`

which renders like this:
isAlphaNumeric(thisChar)

@SeppPenner
Copy link
Collaborator Author

@per1234 Thank you for the investigation. I will change this.

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

No branches or pull requests

2 participants