QuantEcon / QuantEcon/lecture-python-programming.fa

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

Offen
#46 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Python
Sterne
1
Forks
1
Ø Merge
10 Std. 5 Min.
Gemergte PRs (30 T.)
5

Beschreibung

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Durchsicht von about_py.md und der bestehenden RTL-Behandlung in getting_started.md. Untersuche anschließend das Vorschauverhalten für die aufgeführten englischen Textfragmente. Kläre, ob das erwartete Ergebnis eine Dokumentationsaktualisierung, manuelle LTR-Korrekturen oder eine Theme-Änderung ist; als abgeschlossen gilt die Aufgabe, wenn eine gemeinsame Richtung festgelegt ist und eine konsistente Darstellung in den persischen Vorlesungsdateien erreicht wurde.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation, internationalization
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.