پروژه Sympy

این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.

خلاصه پروژه

سازمان منبع باز:
SymPy
نویسنده فنی:
سومی 7
نام پروژه:
سازگاری در رشته‌های مستند - اسناد Sympy
طول پروژه:
طول استاندارد (3 ماه)

شرح پروژه

چکیده:

وضعیت فعلی اسناد Sympy و کارهای قبلی:

  • کار ایجاد یک راهنمای رسمی سبک برای SymPy به پایان رسیده است.

  • پروژه GSoD Lauren Glattly یک راهنمای سبک برای رشته‌های اسناد SymPy ایجاد کرد که می‌توانید آن را در SymPy Documentation Style Guide پیدا کنید.

  • رشته‌های اسناد در زیر ماژول ویژه و فایل Solrs.py برای پیروی مداوم از دستورالعمل‌های راهنمای سبک جدید ویرایش شدند.

  • تمام رشته‌های اسناد دیگر در پایگاه کد همچنان باید ویرایش می‌شد تا با راهنمای سبک جدید نیز مطابقت داشته باشد.

کار پیشنهادی:

  • بیشتر رشته‌های اسناد در SymPy هنوز از آخرین راهنمای سبک پیروی نمی‌کنند. هدف این پروژه به‌روزرسانی رشته‌های اسناد در سراسر SymPy برای رعایت این راهنما است.

  • من در مورد پروژه با مربیان بحث کردم. اینم لینک بحث

  • تصمیم گرفته شد که ویرایش رشته‌های اسناد در سرتاسر پایگاه کد sympy برای رعایت آخرین راهنمای سبک کار بزرگی است و پروژه باید به آن محدود شود.

  • کار من روی این پروژه شامل اجرای راهنمای جدید برای به‌روزرسانی رشته‌های اسناد موجود، در عین جمع‌آوری و رسیدگی به تناقضات دیگر مانند استفاده از زبان یا اصطلاحات است.

  • ترتیب زیربخش های موجود را می توان تغییر داد یا بعداً یا به عنوان یک کار جداگانه تصمیم گرفت.

  • نشان دادن تفاوت در نتایج زمانی که مقادیر مختلف به پارامترها منتقل می شود با افزودن مثال های بیشتر همراه با بخش اضافه کردن پارامترها.

  • به اضافه کردن مثال های پیچیده به بخش گوچاها و دام ها ادامه دهید.

مشارکت‌ها: - #17887: روی شماره 17887 کار شد: بخش‌های docstring از دست رفته را در زیر ماژول ویژه اضافه کنید. من بخش پارامترها و مثال‌های گمشده را در برخی از توابع زیرماژول Specials اضافه کردم که توسط L. Glattly ویرایش شد تا از آخرین راهنمای سبک پیروی کند و به عنوان مدلی برای رشته‌های اسنادی آینده باشد.

این لینک به روابط عمومی ادغام شده من است: https://github.com/sympy/sympy/pull/19334

  • #19591: شماره 19591 راهنمای سبک مستندسازی را دنبال می‌کند. من یک PR برای ویرایش core.sympify docstring اضافه کردم تا به آخرین راهنمای سبک پایبند باشم. من توضیحات ساختار یافته و مثال هایی در مورد استفاده از پارامترهای مختلف اضافه کرده ام.

در اینجا یک پیوند به روابط عمومی وجود دارد: https://github.com/sympy/sympy/pull/19613

اهداف پروژه

جدول زمانی قبل از 17 آگوست:

  • به کمک به سازمان ادامه دهید.
  • با اسناد کاربر و نسخه فعلی sympy بیشتر آشنا شوید.
  • تکنیک ها و مهارت هایی را بیاموزید که در اجرای پروژه مفید خواهند بود.

پیوند جامعه: (17 اوت - 13 سپتامبر 2020)

  • راه اندازی یک کانال ارتباطی و زمان (به دلیل اختلاف زمانی).
  • اهدافم را اصلاح کنم و انتظاراتم را از هر دو طرف مشخص کنم.
  • بحث در مورد ترتیب به روز رسانی ماژول ها.
  • ترتیب ویرایش ماژول ها را نهایی کنید تا آنها را به آخرین راهنمای سبک docstring پایبند کنید.

دوره مستندسازی (14 سپتامبر 2020 - 30 نوامبر 2020):

  • اهدافی را برای رسیدن به هر هفته تعیین کنید، ترجیحاً رشته‌های مستند یک ماژول یا زیر ماژول را در هفته یا بیشتر به‌روزرسانی کنید.

  • برای همه این ماژول‌ها، هدف اصلی من اضافه کردن بخش‌های از دست رفته و تغییر ساختار رشته‌های مستند برای پیروی از آخرین راهنمای سبک خواهد بود. این شامل نشان دادن نتایج متفاوتی است که هنگام ارسال مقادیر مختلف به پارامترها به دست می‌آید. تمام خروجی های روی حیله و تزویر باید به بخش Gotchas و Pitfalls اضافه شوند.

  • هفته 1 (14 سپتامبر - 21 سپتامبر): هسته

  • هفته 2 (22 سپتامبر - 29 سپتامبر): توابع: زیرماژول های ترکیبی

  • هفته 3 (30 سپتامبر - 6 اکتبر): توابع

  • هفته 4 (7 اکتبر - 14 اکتبر): Simplify، Crypto

  • هفته 5 (15 اکتبر - 21 اکتبر): دیوفانتین

  • هفته 6 (22 اکتبر - 29 اکتبر): هولونومیک: زیرماژول عملیات

  • هفته 7 (30 اکتبر - 7 نوامبر): ماژول انتگرال ها (integrals.integrals)، انتگرال های محاسباتی با استفاده از توابع Meijer G

  • هفته 8 (8 نوامبر - 15 نوامبر): فیزیک، توابع در پایان ماژول دسته ها، ماژول تولید کد، ماژول ویژه فرعی

  • هفته 9 (16 نوامبر - 23 نوامبر): فیزیک، توابع در پایان ماژول دسته ها، ماژول تولید کد، ماژول ویژه فرعی

  • هفته 10 (24 نوامبر - 30 نوامبر): بخش Gotchas و Pitfalls

  • 30 نوامبر - 5 دسامبر 2020 ساعت 18:00 UTC: ارسال نهایی پروژه و گزارش نوشتن

  • 3 - 10 دسامبر 2020 ساعت 18:00 UTC : ارسال موفقیت پروژه و تجربه کار با مربیان

  • ترتیب ماژول های ذکر شده در اینجا پس از بحث بیشتر با مربیان قابل تغییر است.

  • همانطور که توسط مربیان پیشنهاد شده است، ابتدا بر روی به روز رسانی آن ماژول هایی تمرکز می کنم که به روز رسانی آسان تر است، سپس به سراغ موارد پیچیده می روم.

چرا من شخص مناسبی برای این پروژه هستم؟

  • من معتقدم که شخص مناسبی برای این پروژه هستم زیرا تجربه قبلی در نوشتن فنی با علوم کامپیوتر دارم و با git و github به خوبی آشنا هستم.

  • از آنجایی که من روابط عمومی را برای به روز رسانی اسناد به آخرین راهنمای سبک در sympy ارسال کرده ام که با موفقیت ادغام شده اند، به جریان کار و مشارکت منظم اطمینان دارم.

  • در ابتدا که شروع به مشارکت کردم، با برخی خطاها روبرو شدم. من در نهایت به اجرای آزمایش ها و ساختن اسناد هر بار قبل از انجام تغییرات عادت کردم زیرا این بسیار مهم است.

  • من در مشارکت در این پروژه بسیار راحت هستم و مشتاقانه منتظر آن هستم.