Undocumented Python objects

[ad-m]

advicer.forms

Classes:

• * AdviceForm
• * AttachmentForm

advicer.models

Classes:

• * AbstractCategory
• * Advice -- missing methods:
• - get_absolute_url
• - get_next_by_created_on
• - get_next_by_grant_on
• - get_previous_by_created_on
• - get_previous_by_grant_on
• * AdviceQuerySet

advicer.views

Classes:

• * AdviceCreate
• * AdviceDelete
• * AdviceDetail
• * AdviceList
• * AdviceUpdate
• * VisibleMixin

cases.forms

Classes:

• * CaseForm
• * CaseGroupPermissionForm

cases.models

Functions:

• * assign_perm_new_case
• * notify_new_case

Classes:

• * Case -- missing methods:
• - assign_perm
• - get_absolute_url
• - get_by_email
• - get_edit_url
• - get_email
• - get_next_by_created_on
• - get_next_by_status_changed
• - get_next_for_user
• - get_next_or_prev_for_user
• - get_prev_for_user
• - get_previous_by_created_on
• - get_previous_by_status_changed
• - get_readed
• - get_status_display
• - get_users_with_perms
• - perm_check
• - send_notification
• - status_display
• - status_update
• - update_counters
• - update_handled
• - view_perm_check
• * CaseQuerySet
• * CaseUserObjectPermission -- missing methods:
• - delete
• - save

cases.views.cases

Classes:

• * CaseDetailView
• * CaseListView
• * CaseUpdateView

cases.views.permissions

Functions:

• * assign_perm_check

Classes:

• * CaseGroupPermissionView
• * UserPermissionCreateView
• * UserPermissionUpdateView

events.forms

Classes:

• * EventForm

events.models

Classes:

• * Event -- missing methods:
• - execute
• - get_absolute_url
• - get_calendar_url
• - get_edit_url
• - get_next_by_created_on
• - get_next_by_time
• - get_previous_by_created_on
• - get_previous_by_time
• * EventQuerySet

events.views

Functions:

• * dismiss

Classes:

• * CalendarEventView
• * CalendarListView
• * EventCreateView
• * EventUpdateView
• * ICalendarView

feedback_custom.forms

Classes:

• * CustomFeedbackForm

keys.forms

Classes:

• * KeyForm

keys.models

Classes:

• * Key -- missing methods:
• - get_absolute_url
• - get_next_by_created_on
• - get_previous_by_created_on
• * KeyQuerySet

keys.views

Classes:

• * KeyCreateView
• * KeyDeleteView
• * KeyDetailView
• * KeyListView

letters.forms

Classes:

• * AddLetterForm
• * AttachmentForm
• * LetterForm
• * NewCaseForm
• * SendLetterForm
• * SimpleSubmit
• * UserEmailField

letters.models

Functions:

• * mail_process

Classes:

• * Letter -- missing methods:
• - get_absolute_url
• - get_edit_url
• - get_genre_display
• - get_next_by_accept
• - get_next_by_created_on
• - get_next_by_status_changed
• - get_previous_by_accept
• - get_previous_by_created_on
• - get_previous_by_status_changed
• - get_send_url
• - get_status_display
• - get_users
• - is_done
• - send_notification
• - set_new_case
• * LetterQuerySet

navsearch.views

Classes:

• * AutocompleteView

notifications_custom.views

Classes:

• * NotificationListView

records.models

Classes:

• * AbstractRecord
• * AbstractRecordQuerySet
• * Record -- missing methods:
• - case_get_absolute_url
• - get_next_by_created_on
• - get_previous_by_created_on
• - get_users_with_perms
• * RecordQuerySet

tasty_feedback.forms

Classes:

• * FeedbackForm

tasty_feedback.models

Functions:

• * notify_manager

Classes:

• * Feedback -- missing methods:
• - get_absolute_url
• - get_github_link
• - get_next_by_created
• - get_next_by_status_changed
• - get_previous_by_created
• - get_previous_by_status_changed
• - get_status_display

tasty_feedback.views

Classes:

• * FeedbackCreateView
• * FeedbackDetailView
• * FeedbackListView
• * FeedbackStatusView

users.models

Classes:

• * CustomUserManager
• * User -- missing methods:
• - get_absolute_url
• - get_codename
• - get_next_by_date_joined
• - get_nicename
• - get_previous_by_date_joined
• - notify
• - send_template_email
• * UserQuerySet

users.views

Classes:

• * ProfileUpdateView
• * UserDetailView
• * UserListView
• * UserRedirectView
• * UserUpdateView

[AgnieszkaZdanowicz]

@ad-m czy to aktualne?

[AgnieszkaZdanowicz]

nie wiem, czy tu jest coś do zrobienia czy można zamykać. @mrbojko @PiotrIw pozostawiam Wam do oceny.

[PiotrIw]

Aktualne, jeśli zakładamy że każdy obiekt w kodzie jest opisany tak jak to się robi zgodnie z dobrymi standardami. Pytanie jaki standard dokumentacji kodu chcemy przyjąć jeśli wysoki to sporo jest do zrobienia. Jednak kod aplikacji jako taki jest napisany czytelnie i ja np nie mam problemu z jego czytaniem, zrozumieniem i dodawaniem nowych lub poprawianiem istniejących elementów.
Zostawiłbym jako zanotowane TODO, jednak z niskim prirytetem. W wolnej chwili mogę spróbować wygenrować coś AI'em :)

[AgnieszkaZdanowicz]

@PiotrIw zróbmy tak, jak proponujesz. Skoro kod jest czytelny, to nie ma co jeszcze podnosić poprzeczki :)