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

PD Controller example is labelled as "PD_Controller" instead of "PDController" on website #3565

Closed
samm82 opened this issue Jul 25, 2023 · 5 comments · Fixed by #3665
Closed
Assignees
Labels
artifacts bug easy At quick glance, it should be 'easy,' but you never know what'll happen!

Comments

@samm82
Copy link
Collaborator

samm82 commented Jul 25, 2023

I noticed this before but waited in case #3521 fixed this. The PD Controller example is called exactly that, space included:

pdControllerApp = commonIdeaWithDict "pdControllerApp" (pn "PD Controller") "PD Controller" []

However, it seems that on the website, this space is replaced with an underscore instead of just being omitted:
image
A consequence of this is that the links generated are incorrect:
image
Removing these underscores from the URL leads to the correct page:
image

Since this is the only example name with a space, I think there is likely a function that gets called at some point that replaces spaces with underscores, when they should just be omitted (at least in the use case of the website).

@samm82 samm82 added bug easy At quick glance, it should be 'easy,' but you never know what'll happen! artifacts labels Jul 25, 2023
@smiths
Copy link
Collaborator

smiths commented Jul 26, 2023

Good catch @samm82. We should definitely fix this.

@JacquesCarette
Copy link
Owner

I think pn should give a hard error if the "proper noun" being given has some forbidden characters in it.

@balacij
Copy link
Collaborator

balacij commented Sep 15, 2023

Off-topic: should the acronym for PD Controller instead be PDC? PD Controller seems to break continuity with the 'normal' acronym naming scheme.

@smiths
Copy link
Collaborator

smiths commented Sep 15, 2023

I think we'll have a tough time coming up with consistent acronym rules. The people in the field talk about PID controllers and PD controllers. They don't say PDC. In this case, it is more important that we follow the conventions of the community.

@balacij
Copy link
Collaborator

balacij commented Sep 15, 2023

That makes sense. Thank you, @smiths!

Regarding the issue, the problem area is obvious enough, but a proper solution isn't quite clear. The problem has to do with programName usage. Hopefully I'll figure it out tomorrow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
artifacts bug easy At quick glance, it should be 'easy,' but you never know what'll happen!
Projects
None yet
4 participants