Ta strona zawiera szczegóły projektu technicznego do pisania w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- SymPy
- Pisarz techniczny:
- Soumi7
- Nazwa projektu:
- Spójność w opisach funkcji – dokumentacja Sympy
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
W skrócie :
Obecny stan dokumentacji Sympy i poprzednie prace :
Zakończyliśmy tworzenie oficjalnego przewodnika po stylu SymPy.
W ramach projektu GSoD Lauren Glattly został stworzony przewodnik po stylu dla opisów funkcji SymPy, który można znaleźć w przewodniku po stylu dokumentacji SymPy.
Ciągi znaków w module specjalnym i w pliku resolvers.py zostały zmodyfikowane tak, aby konsekwentnie były zgodne ze wskazówkami dotyczącymi nowego przewodnika stylu.
Wszystkie pozostałe opisy w kodziku trzeba było jeszcze zmienić, aby były zgodne z nowymi wytycznymi.
Proponowane działania :
Większość opisów funkcji w SymPy nadal nie jest zgodna z najnowszą instrukcją stylu. Celem tego projektu jest zaktualizowanie docstringów w całym SymPy zgodnie z tym przewodnikiem.
Omówiliśmy projekt z mentorami. Oto link do dyskusji.
Zdecydowaliśmy, że edytowanie docstringów w całym kodzie źródłowym sympy w celu dostosowania go do najnowszego przewodnika stylu to duże zadanie i projekt powinien się na tym skończyć.
Moja praca w ramach projektu polegałaby na wdrożeniu nowego przewodnika w celu zaktualizowania istniejących opisów funkcji, a także na zebraniu i usunięciu innych niespójności, takich jak użycie języka czy określenia.
Kolejność istniejących podsekcji można zmienić lub ustalić później lub jako osobne zadanie.
Wykazywanie różnic w wynikach, gdy do parametrów przekazywane są różne wartości, poprzez dodanie większej liczby przykładów i sekcji z dodatkowymi parametrami.
W sekcji z potencjalnymi problemami i pułapkami dodawaj też podchwytliwe przykłady.
Publikacje: - #17887 : Opracowano problem nr 17887: Dodawanie brakujących sekcji z ciągami dokumentów w specjalnym module podrzędnym. Dodałem brakujące sekcje Parametry i Przykłady w niektórych funkcjach podmodułu Specjalne, który został zmodyfikowany przez L. Glattly ma być zgodny z najnowszym stylebookiem i przykładem dla przyszłych opisów funkcji.
Oto link do połączonego PR : https://github.com/sympy/sympy/pull/19334
- #19591 : zgłoszenie #19591 dotyczy poradnika stylu w dokumentacji. Dodałam PR, aby edytować opis funkcji core.sympify zgodnie z najnowszą wersją poradnika. Dodaliśmy uporządkowane wyjaśnienia i przykłady użycia różnych parametrów.
Oto link do PR: https://github.com/sympy/sympy/pull/19613
Cele projektu
Czas rozpoczęcia: Przed 17 sierpnia:
- nadal przyczyniać się do rozwoju organizacji;
- Dokładnie zapoznaj się z dokumentacją użytkownika i bieżącą wersją sympy.
- Poznaj techniki i umiejętności, które przydadzą się podczas wdrażania projektu.
Budowanie więzi w społeczności : (17 sierpnia – 13 września 2020 r.)
- Skonfiguruj kanał komunikacji i termin (ze względu na różnicę czasu).
- Doprecyzuj cele i określ oczekiwania po obu stronach.
- omówienie kolejności aktualizowania modułów;
- Zakończ edycję modułów, aby były zgodne z najnowszym stylem opisów funkcji.
Okres dokumentacji(14 września – 30 listopada 2020 r.) :
Ustal cele do osiągnięcia co tydzień, najlepiej aktualizuj opisy funkcji w jednym module lub podmodule co tydzień lub częściej.
W przypadku wszystkich tych modułów moim głównym celem będzie dodanie brakujących sekcji i przekształcenie docstrings zgodnie z najnowszym styleguidem. Obejmuje to prezentowanie różnych wyników uzyskanych, gdy do parametrów zostaną przekazane różne wartości. Wszystkie trudne do interpretacji wyniki należy dodać do sekcji „Pułapki i pułapki”.
Tydzień 1 ( 14–21 września) : podstawy
Tydzień 2 (22–29 września) : funkcje : podmoduły kombinatoryczne
Tydzień 3 (30 września – 6 października) : funkcje
Tydzień 4 (7–14 października) : prostota, kryptografia
Tydzień 5 (15–21 października) : Diophantine
Tydzień 6 (22–29 października):podmoduł Holonomic :Operations
Tydzień 7 (30 października–7 listopada) : moduł całki(integrals.integrals), obliczanie całki za pomocą funkcji Meijer G.
Tydzień 8 (8–15 listopada) : fizyka, funkcje na końcu modułu Kategorie, moduł Generowanie kodu, moduł specjalny
Tydzień 9 (16–23 listopada) : fizyka, funkcje na końcu modułu Kategorie, moduł Generowanie kodu, moduł specjalny
Tydzień 10 (24–30 listopada) : sekcja „Pułapki i pułapki”
30 listopada – 5 grudnia 2020 r., godz. 18:00 UTC : przesłanie ostatecznej wersji projektu i opracowanie raportu
3–10 grudnia 2020 r., godz. 18:00 czasu UTC : przesłanie projektu i doświadczenia w pracy z mentorami
Kolejność wymienionych tu modułów może ulec zmianie po dalszej rozmowie z mentorami.
Zgodnie z zaleceniem mentorów najpierw skupię się na aktualizacji tych modułów, które są łatwiejsze do zaktualizowania, a potem przejdę do tych bardziej skomplikowanych.
Dlaczego jestem odpowiednią osobą do tego projektu?
Uważam, że jestem odpowiednią osobą do tego projektu, ponieważ mam doświadczenie w pisaniu tekstów technicznych z zakresu informatyki i znam się na git i github.
Przesłałem PR-y, aby zaktualizować dokumentację zgodnie z najnowszą wersją przewodnika po stylu w sympy, które zostały scalone. Jestem pewien, że wszystko jest w porządku i że regularnie wnoszę swój wkład.
Na początku wystąpiły błędy. W końcu przyzwyczaiłam się do testowania i tworzenia dokumentów za każdym razem przed wprowadzeniem zmian. To bardzo ważne.
Chętnie wezmę udział w tym projekcie.