Skip to content

docs: fix nested list formatting in tgb docstring #2779#2880

Open
Rajat-Kumawat wants to merge 1 commit into
Avaiga:developfrom
Rajat-Kumawat:docs/nested-lists-tgb-2779
Open

docs: fix nested list formatting in tgb docstring #2779#2880
Rajat-Kumawat wants to merge 1 commit into
Avaiga:developfrom
Rajat-Kumawat:docs/nested-lists-tgb-2779

Conversation

@Rajat-Kumawat

Copy link
Copy Markdown

What type of PR is this? (Check all that apply)

  • 🛠 Refactor
  • ✨ Feature
  • 🐛 Bug Fix
  • ⚡ Optimization
  • 📝 Documentation Update

Description

Fixed a formatting issue where the 3 levels of nesting inside the on_action docstring for the sharedInput component were not rendering correctly in IDEs like VS Code. Converted the raw HTML <ul>/<li> list structure to native Markdown formatting with proper indentation to guarantee clean nested bullet points.

Related Tickets & Documents

How to reproduce the issue

Backporting

This change should be backported to:

  • 3.0
  • 3.1
  • 4.0
  • develop

Checklist

We encourage keeping the code coverage percentage at 80% or above.

  • ✅ This solution meets the acceptance criteria of the related issue.
  • 📝 The related issue checklist is completed.
  • 🧪 This PR includes unit tests for the developed code.
    If not, explain why:
  • 🔄 End-to-End tests have been added or updated.
    If not, explain why:
  • 📚 The documentation has been updated, or a dedicated issue has been created.
    If not, explain why:
  • 📌 The release notes have been updated.
    If not, explain why:

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[📄 DOCS] Formatting issue with nested lists in tgb docstring

1 participant