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.

Sign up for GitHub

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

Jump to bottom

✨Render python component descriptions as markdown #171

Merged
merged 8 commits into from
Jul 18, 2022
Merged

✨Render python component descriptions as markdown #171

merged 8 commits into from
Jul 18, 2022

Conversation

AdrySky
Copy link
Contributor

@AdrySky AdrySky commented Jul 13, 2022 •
edited
Loading

Description

This will render component's description as markdown. Also, can use HTML style. (Not recommended)

Markdown in description v2

Pull Request Type

  • Xircuits Core (Jupyterlab Related changes)
  • Xircuits Canvas (Custom RD Related changes)
  • Xircuits Component Library
  • Testing Automation
  • Documentation
  • Others (Please Specify)

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Tests

  1. Use markdown style on component's description
    1. Open any node's script
    2. Edit its docstring as markdown (As shown in gif)
    3. Open node's description on canvas
    4. It should style accordingly
    5. And any links should be in blue color and clickable

Tested on?

  • Windows
  • Linux Ubuntu
  • Centos
  • Mac
  • Others (State here -> xxx )

Notes

Can also use HTML style. (Not recommended)

@AdrySky AdrySky added the enhancement New feature or request label Jul 13, 2022
@AdrySky AdrySky requested a review from MFA-X-AI July 13, 2022 08:30
@AdrySky AdrySky self-assigned this Jul 13, 2022
@AdrySky AdrySky changed the title ✨Clickable links in component's description ✨Render python component descriptions as markdown Jul 14, 2022
MFA-X-AI
MFA-X-AI approved these changes Jul 18, 2022
View reviewed changes
Copy link
Member

@MFA-X-AI MFA-X-AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!
Looks solid from my side. Comments are rendered as markdown correctly and I can beautify all the default components. 😄
rich markdown tooltip

Bonus: with HTML it can load cool stuff like images.
xircuits html render

Great work!

@MFA-X-AI MFA-X-AI merged commit 2c8b55f into master Jul 18, 2022
@MFA-X-AI MFA-X-AI deleted the adry/link-in-desc branch July 18, 2022 12:16
@MFA-X-AI MFA-X-AI mentioned this pull request Jul 27, 2022
Merged
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MFA-X-AI MFA-X-AI MFA-X-AI approved these changes

Assignees

@AdrySky AdrySky

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AdrySky @MFA-X-AI