Skip to content

Improvements to the custom components docs #753

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

Merged
merged 2 commits into from
Jul 5, 2025

Conversation

pydanny
Copy link
Contributor

@pydanny pydanny commented Jul 3, 2025


name: Pull Request
about: Propose changes to the codebase
title: '[PR] Improve custom components docs'
labels: 'documentation'
assignees: ''


Related Issue

Issue #713 and this supersedes PR #715.

The current custom docs leads with NotStr, mixes details about automatic and manual creation of tags, and could introduct handling special cases better.

Proposed Changes

  • Moves NotStr to the end introduced as a last-ditch patch
  • Moves details of how automatic creation works out of manual creation and to where it belongs: automatic creation
  • Puts special cases like special characters into their own dedicated "Special Cases" section.

Types of changes
What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist
Go over all the following points, and put an x in all the boxes that apply:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I am aware that this is an nbdev project, and I have edited, cleaned, and synced the source notebooks instead of editing .py or .md files directly.

Additional Information

The original writing was excellent, so mostly this was a reorganization of content rather than a full rewrite. Polishing the good stuff, as it were. 😄

Copy link

gitnotebooks bot commented Jul 3, 2025

Found 1 changed notebook. Review the changes at https://app.gitnotebooks.com/AnswerDotAI/fasthtml/pull/753

@pydanny pydanny changed the title Improve custom components docs Improvements to the custom components docs Jul 3, 2025
@pydanny pydanny closed this Jul 3, 2025
@pydanny pydanny reopened this Jul 3, 2025
@jph00
Copy link
Contributor

jph00 commented Jul 5, 2025

Thanks @pydanny ! :D

@jph00 jph00 merged commit 556b5b2 into AnswerDotAI:main Jul 5, 2025
2 checks passed
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.

2 participants