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

Standardize letter case in titles #1274

Open
arcanaxion opened this issue Feb 5, 2025 · 9 comments
Open

Standardize letter case in titles #1274

arcanaxion opened this issue Feb 5, 2025 · 9 comments
Assignees
Labels
📄 Documentation Internal or public documentation good first issue New-contributor friendly 📈 Improvement Improvement of a feature. 🟨 Priority: Medium Not blocking but should be fixed soon 🥶Waiting for contributor Issues or PRs waiting for a long time

Comments

@arcanaxion
Copy link
Contributor

Description
Titles are currently inconsistent. See the following screenshot of the user manual:

Image

Notice that the side bar is mostly sentence case, but is inconsistent (see "Elements", "Values", "Trigger").

Expected change
After skimming through the docs of some popular Python packages, I think sentence case is a good choice. I don't have a strong opinion, except for consistency.

I would change Tutorials to sentence case to match User Manual. I would preserve Gallery since the title's may be interpreted as application names (proper nouns).

@arcanaxion arcanaxion added the 📈 Improvement Improvement of a feature. label Feb 5, 2025
@arcanaxion
Copy link
Contributor Author

@FlorianJacta Could you assign this to me please

@jrobinAV
Copy link
Member

jrobinAV commented Feb 5, 2025

@arcanaxion I globally agree the current situation is disturbing. It seems inconsistent. At least, the motivation is not clear to the reader so it looks like it is messy with typos.

  1. For products and brands like "Databricks", "Ngrok", "Taipy Designer", etc. I would keep the official typo with upper cases.
  2. For the terms "Elements" and "Values", It seems it is done on purpose but I would remove the upper cases. @FabienLelaquais, any opinion, reason or motivation?
  3. For the term "Trigger", I did it on purpose because I wanted to exhibit the two different parts of the title. But the rendering is ugly (😄). Let's use sentence case for this title, using "trigger".
  4. I would also keep upper cases for acronyms like "TOML", "API", "REST", "CLI", etc.
  5. I would also align the Gallery.

Before rushing to change it, I would like to align all the stakeholders. @arcanaxion @FlorianJacta @AlexandreSajus @FabienLelaquais. What do you think?

@FabienLelaquais
Copy link
Member

So most of these (talink about the Extension libraries) are new, in 'develop', and are wrong.
There's no good reason to use a capitalized 'Element' there (which is in 'latest' as well).

I agree these must be fixed.

@jrobinAV
Copy link
Member

jrobinAV commented Feb 5, 2025

@arcanaxion Can you handle the changes on both develop and release/4.0 branches?

@jrobinAV jrobinAV added 📄 Documentation Internal or public documentation 🟨 Priority: Medium Not blocking but should be fixed soon good first issue New-contributor friendly labels Feb 5, 2025
@arcanaxion
Copy link
Contributor Author

@jrobinAV

  1. Agreed, they are proper nouns.
  2. I searched "List of Values" (case-sensitive) in the docs and found 4 matches. I propose changing them all to "list of values". There may be merit to giving these a new name entirely (in a separate issue), since they are sort of a Taipy terminology (they are not simply a list of values, but have a specific format).
  3. Understandable intent but I agree that it should be changed to sentence case.
  4. Agreed, acronyms should be uppercase.
  5. I think the applications in Gallery make sense as application titles. E.g. "App Store", the name of Apple's app store. I also don't have a strong preference, but I'm inclined to leave them in title case.

Do let me know your thoughts and I'll make the changes accordingly

@FlorianJacta
Copy link
Member

I don't have a strong opinion on this

@jrobinAV
Copy link
Member

jrobinAV commented Feb 5, 2025

@arcanaxion Sounds good to me. Thanks for the help.

@AlexandreSajus
Copy link
Contributor

I don't have a strong opinion on this

Same, I never noticed

Copy link

This issue has been labelled as "🥶Waiting for contributor" because it has been inactive for more than 14 days. If you would like to continue working on this issue, please add another comment or create a PR that links to this issue. If a PR has already been created which refers to this issue, then you should explicitly mention this issue in the relevant PR. Otherwise, you will be unassigned in 14 days. For more information please refer to the contributing guidelines.

@github-actions github-actions bot added the 🥶Waiting for contributor Issues or PRs waiting for a long time label Feb 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 Documentation Internal or public documentation good first issue New-contributor friendly 📈 Improvement Improvement of a feature. 🟨 Priority: Medium Not blocking but should be fixed soon 🥶Waiting for contributor Issues or PRs waiting for a long time
Projects
None yet
Development

No branches or pull requests

5 participants