Questions regarding updating about_py.md and handling LTR fragments in RTL layout

Open
#46 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation, internationalization

Research direction

Start by reviewing about_py.md and the existing RTL handling in getting_started.md, then inspect the preview behavior for the listed English fragments. Clarify whether the expected outcome is a documentation update, manual LTR fixes, or a theme change; done requires an agreed direction and consistent rendering in the Persian lecture files.

Written by the indexing model from the issue text.

Description

Hi @mmcky
I have two questions as I continue reviewing the Persian lecture files:

1.Update of about_py.md
Based on the updates you recently applied to the other lectures — including the new conventions for figure directives, LaTeX alignment — the overall structure of the lecture series has now become consistent and standardized.
The about_py.md lecture, however, still follows the older structure. I wanted to ask whether you are planning to update this lecture as well so that it aligns with the new conventions.
If this update is planned, will you be handling it, or would you prefer that I apply the necessary changes and open a PR?

2.LTR content inside RTL text
Some English fragments need to remain left-to-right within the Persian (RTL) text, for example:

  • file extensions (e.g., .ipynb)
  • function names (e.g., append())
  • assignments or short code expressions (e.g., ϵ_values = [])

These currently render right-to-left in the preview.
Should I continue fixing these manually (as I did in getting_started.md by reversing placement), or do you expect that the theme will eventually handle such cases automatically?

Thank you, and please let me know how you would like me to proceed.

Dominant language
Python
Stars
1
Forks
1
Avg merge
10h 5m
Merged PRs (30d)
5

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from QuantEcon/lecture-python-programming.fa

All issues in QuantEcon/lecture-python-programming.fa

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.