Skip to content

Add / correct function comments #195

@matt-bernhardt

Description

@matt-bernhardt

According to some recent CodeSniffer results, there are a number of functions in this theme that don't have appropriate documentation - mostly the lack of function comments at all, but also some cases of incorrectly-structured documentation.

Writing this documentation might be a useful ramp-up project for a new developer (or a project to tackle during down time for a current developer).

  • Writing documentation is a no-stakes effort since it doesn't affect how the theme operates
  • Writing good documentation is a good way to learn how something works (as Angie Byron wrote some years ago, "Document your way to understanding")

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions