Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- SymPy
- Pisarz techniczny:
- Soumi7
- Nazwa projektu:
- Spójność w dokumentach – dokumentacja Sympy
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
W skrócie :
Bieżący stan dokumentacji Sympy i poprzednie prace :
Prace nad opracowaniem oficjalnego przewodnika stylistycznego dla SymPy zostało zakończone.
W ramach projektu GSoD Lauren Glattly powstał przewodnik stylistyczny dotyczący ciągów dokumentacyjnych SymPy, który można znaleźć w przewodniku po stylu dokumentacji SymPy.
Ciągi dokumentów w module specjalnym i pliku resolvers.py zostały zmodyfikowane w taki sposób, aby były zgodne z wytycznymi nowego przewodnika.
Pozostałe dokumenty w bazie kodu również musiały zostać wyedytowane w celu zapewnienia zgodności z nowym przewodnikiem stylistycznym.
Proponowane dzieło :
Większość struny dokumentów w SymPy nadal jest niezgodna z najnowszymi wskazówkami dotyczącymi stylu. Celem tego projektu jest zaktualizowanie plików dokumentacji w SymPy zgodnie z tym przewodnikiem.
Omówiłam projekt z mentorami. Oto link do dyskusji.
Uznano, że edycja fragmentów kodu w bazie kodu sympy zgodnie z najnowszymi wskazówkami dotyczącymi stylu jest dużym zadaniem i projekt powinien być ograniczony do tego elementu.
Moja praca w ramach projektu obejmowałaby wdrożenie nowego przewodnika po aktualizacji istniejących ciągów dokumentów, a także gromadzenie i eliminowanie innych niespójności, takich jak użycie języka czy terminy.
Kolejną kolejność istniejących podsekcji można zmienić lub ustalić później albo jako osobne zadanie.
Przedstawienie różnic w wynikach, jakie występują w przypadku przekazywania różnych wartości do parametrów przez dodanie większej liczby przykładów wraz z dodaniem sekcji parametrów.
W sekcji z wątpliwościami i pułapkami możesz stale dodawać trudne przykłady.
Darowizny: – #17887 : Rozpatrzono numer 17887: Dodanie brakujących sekcji ciągów doc. w specjalnym module podrzędnym. Dodałem brakującą sekcję parametrów i przykładów w niektórych funkcjach modułu podrzędnego Oferty specjalne, który był edytowany przez L. Z odwagą podąża za najnowszymi wskazówkami dotyczącymi stylu i posłuży za wzór dla przyszłych dokumentów.
Oto link do mojego scalonego raportu PR : https://github.com/sympy/sympy/pull/19334
- #19591 : numer #19591 śledzi wskazówki redakcyjne. Dodałem PR, aby edytować ciąg dokumentu core.sympify w celu zachowania zgodności z najnowszym przewodnikiem stylistycznym. Dodaliśmy wyjaśnienia i przykłady zastosowania różnych parametrów.
Oto link do strony PR: https://github.com/sympy/sympy/pull/19613
Cele projektu
Harmonogram Przed 17 sierpnia :
- Kontynuuj wpłatę na rzecz organizacji.
- Zapoznaj się z dokumentacją użytkownika i aktualną wersją sympy.
- Poznaj techniki i umiejętności, które będą przydatne podczas realizacji projektu.
Nawiązywanie więzi ze społecznością : (17 sierpnia–13 września 2020 r.)
- Skonfiguruj kanał komunikacji i godzinę (ze względu na różnicę czasu).
- Przedstawiciel sprecyzował moje cele i określił oczekiwania po obu stronach.
- Omówienie kolejności aktualizacji modułów.
- Sfinalizuj kolejność modułów edycji, aby była zgodna z najnowszymi wskazówkami dotyczącymi stylu w dokumentach.
Okres dokumentacji(14 września 2020 r. – 30 listopada 2020 r.) :
Wyznacz cele do osiągnięcia co tydzień. Zalecamy aktualizowanie 1 modułu lub podmodułu co najmniej raz w tygodniu.
W przypadku wszystkich tych modułów moim głównym celem jest dodanie brakujących sekcji i zmiana struktury ciągów dokumentów zgodnie z najnowszymi wskazówkami dotyczącymi stylu. Obejmuje to pokazanie różnych wyników uzyskiwanych przy przekazywaniu różnych wartości do parametrów. Wszystkie trudne dane wyjściowe będą dodawane do sekcji Gotchas i Pitfalls.
Tydzień 1 ( 14 września – 21 września) – główny
Tydzień 2 (22–29 września) : Funkcje : moduły podrzędne
Tydzień 3 (30 września – 6 października) : funkcje
Tydzień 4 (7 października – 14 października) : prostsza obsługa, szyfrowanie
Tydzień 5 (15 października – 21 października) : diefantyna
Tydzień 6 (22 – 29 października):Holonomiczny :moduł podrzędny operacji
Tydzień 7 (30 października–7 listopada) : moduł całkowania(całki, całki), przetwarzanie całkowania przy użyciu funkcji G Meijera
Tydzień 8 (8 listopada–15 listopada) : Fizyka, Funkcje na końcu modułu kategorii, Moduł generowania kodu, moduł podrzędny
Tydzień 9 (16 listopada–23 listopada) : Fizyka, funkcje na końcu modułu kategorii, moduł generowania kodu, moduł specjalny
Tydzień 10 (24 listopada – 30 listopada) : sekcja Gotchas i pułapki
30 listopada – 5 grudnia 2020 r., godz. 18:00 czasu UTC : przesłanie ostatecznego projektu i pisanie raportu
3–10 grudnia 2020 r., godz. 18:00 czasu UTC : zgłoszenie powodzenia projektu i doświadczenia we współpracy z mentorami
Kolejność wspomnianych modułów można zmienić po skonsultowaniu się z mentorami.
Zgodnie z sugestiami mentorów skoncentruję się najpierw na tych modułach, które są łatwiejsze do zaktualizowania, a potem do tych bardziej złożonych.
Dlaczego jestem odpowiednią osobą do tego projektu?
Uważam, że jestem odpowiednią osobą do tego projektu, ponieważ mam doświadczenie w pisaniu technicznego w informatyce informatycznej i dobrze znam się na git i githubie.
Przesłaliśmy działom PR z prośbą o zaktualizowanie dokumentacji do najnowszego przewodnika stylistycznego w ramach sympy, które zostały scalone, więc mam pewność, że przepływ pracy i regularne publikowane treści się pojawią.
Początkowo, gdy zacząłem publikować, napotkałem kilka błędów. Wreszcie przyzwyczaiłam się do uruchamiania testów i tworzenia dokumentów za każdym razem przed wprowadzeniem zmian, bo to bardzo ważne.
Chętnie będę pomagać w tym projekcie i bardzo się cieszę.