Skip to content

Conversation

Aoumjahde
Copy link

@Aoumjahde Aoumjahde commented Sep 11, 2025

All Submissions:

  • Have you followed the guidelines stated in CONTRIBUTING.md file?
  • [ x] Have you checked to ensure there aren't any other open Pull Requests for the desired changed?

Type of change

Please delete options that are not relevant.

  • 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 not work as expected)
  • [x ] This change requires a documentation update

New Feature Submission:

  • [ x] Does your submission pass the tests?
  • [x ] Have you linted your code locally prior to submission?

Changes To Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • [ x] Have you written new tests for your core changes, as applicable?
  • [x ] Have you successfully ran tests with your changes locally?

After these steps, you're ready to open a pull request.

a. Give a descriptive title to your PR.

b. Describe your changes.

c. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).
  1. Just update the index page documentation for the new user, because I find it hard to know how I will start the front and back end servers.
  2. Adding a new JS file (livereload.js) that has functionality to reload the page automatically when changing the same frontend elements.

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Summary

This PR adds instructional comments to the blank app template file (reflex/.templates/apps/blank/code/blank.py) to help new users understand how to run their Reflex application. The change introduces a multi-line comment block (lines 3-7) that provides basic guidance on starting the server with reflex run and accessing the frontend at http://localhost:3000.

This template file serves as the starting point for new Reflex projects when users run reflex init, making it a logical place to include beginner-friendly instructions. The addition aims to improve the developer experience by reducing the learning curve for first-time users who may be unsure how to proceed after creating their initial project.

However, the implementation uses triple quotes (""") which is Python's docstring syntax, but places this comment in the middle of the file rather than at the module, class, or function level where docstrings belong. This could potentially confuse new developers about proper Python documentation conventions.

PR Description Notes:

  • Multiple formatting inconsistencies in the checklist (extra spaces in [ x])
  • The PR description lacks the required detailed explanation of changes and rationale mentioned in the template
  • Missing reference to any related issue that this PR addresses

Confidence score: 2/5

  • This PR introduces potential confusion about Python docstring conventions and contains implementation issues that could mislead new users
  • Score reflects concerns about using incorrect docstring syntax in a template file that serves as an example for new developers
  • Pay close attention to reflex/.templates/apps/blank/code/blank.py for proper comment formatting and Python conventions

Context used:

Rule - Remove commented-out code before merging PRs. (link)

1 file reviewed, 1 comment

Edit Code Review Bot Settings | Greptile

Comment on lines +3 to +7
""" This page is a testing page You can Start the server by:
--> Run in your Terminal : reflex run
--> Open in your Browser http://localhost:3000 for FrontEnd.
"""
Copy link
Contributor

Choose a reason for hiding this comment

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

style: This should use regular comments (#) instead of docstring syntax. Triple quotes are for module/class/function documentation, not general comments.

Suggested change
""" This page is a testing page You can Start the server by:
--> Run in your Terminal : reflex run
--> Open in your Browser http://localhost:3000 for FrontEnd.
"""
# This page is a testing page You can Start the server by:
# --> Run in your Terminal : reflex run
# --> Open in your Browser http://localhost:3000 for FrontEnd.
#

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.

1 participant