Skip to content

Update using-text-class.md#497

Open
marcorensch wants to merge 1 commit intojoomla:mainfrom
marcorensch:patch-3
Open

Update using-text-class.md#497
marcorensch wants to merge 1 commit intojoomla:mainfrom
marcorensch:patch-3

Conversation

@marcorensch
Copy link
Copy Markdown
Contributor

@marcorensch marcorensch commented Aug 15, 2025

User description

Wrong description for examples hasn't covered the example


PR Type

Documentation


Description

  • Fixed incorrect code comments in Text::alt() examples

  • Corrected output descriptions to match actual behavior


Diagram Walkthrough

flowchart LR
  A["Documentation"] --> B["Text::alt() Examples"] --> C["Corrected Comments"]
Loading

File Walkthrough

Relevant files
Documentation
using-text-class.md
Corrected Text::alt() method example comments                       

versioned_docs/version-5.3/general-concepts/multilingual/using-text-class.md

  • Updated Text::alt() method example comments
  • Removed incorrect French translation references
  • Fixed output descriptions to match actual method behavior
+2/-2     

Wrong description for examples hasn't covered the example
@qodo-code-review
Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Possible Inaccuracy

Verify that the updated comments for Text::alt('JALL', ...) accurately reflect current framework behavior and outputs ("All" vs "All together") across locales; ensure removing language-specific mentions doesn't omit important context users may need.

echo Text::alt('JALL', 'language'); // will generate a 'All' string
echo Text::alt('JALL', 'module');   // will generate a 'All together' string

@qodo-code-review
Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

No code suggestions found for the PR.

@HLeithner
Copy link
Copy Markdown
Member

I don't understand why this should be a better explanation as the current.

@robbiejackson
Copy link
Copy Markdown
Contributor

Yes Marco there's clearly something wrong here in the description. But I don't think that echo Text::alt('JALL', 'module'); will output "All together" either. I don't think the Info note is correct either.

I think the whole section needs rewritten to better explain this functionality, but as it doesn't seem to be used much in Joomla I don't reckon it's a high priority.

Feel free to rewrite the section properly if you like, or if you just want to put a warning against the section saying that it needs rewritten then that would be acceptable too.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants