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.

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

Project code for django markdown tutorial #459

Merged
merged 3 commits into from
Nov 11, 2023

Conversation

robalford
Copy link
Contributor

Where to put new files:

  • New files should go into a top-level subfolder, named after the article slug. For example: my-awesome-article

How to merge your changes:

  1. Make sure the CI code style tests all pass (+ run the automatic code formatter if necessary).
  2. Find an RP Team member on Slack and ask them to review & approve your PR.
  3. Once the PR has one positive ("approved") review, GitHub lets you merge the PR.
  4. 🎉

Copy link
Contributor

@bzaczynski bzaczynski left a comment

Choose a reason for hiding this comment

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

@robalford Thanks for the pull request.

I downloaded your fork and made sure that everything works as expected. There's one or two minor tweaks remaining before we can merge. Can you change the directory structure, please?

Thanks!

@@ -0,0 +1,3 @@
# How to Render Markdown in a Django Application
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you move the README file one level up, please? Alternatively, I'm wondering if we need the extra subfolder at all. Maybe that would be a better option, actually:

materials/
└── django_markdown/
    ├── django_markdown/
    ├── django_markdown_app/
    ├── manage.py
    ├── README.md
    └── requirements.txt

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added that top level django-markdown folder based on the instructions above: 'New files should go into a top-level subfolder, named after the article slug. For example: my-awesome-article'.

But I think since I used an underscore in the project name in the tutorial, django_markdown, I will just move the readme file up to the the top level alongside the Django project folder to be consistent. It looks like some of the other Django projects in here are done this way.

Comment on lines 2 to 3
from markdown.inlinepatterns import LinkInlineProcessor, LINK_RE
from django.urls import reverse
Copy link
Contributor

Choose a reason for hiding this comment

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

Probably need to run isort on your codebase to ensure consistent import statement ordering, which complies with PEP 8.

@gahjelle gahjelle merged commit e658370 into realpython:master Nov 11, 2023
1 check 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.

3 participants