Inline Docs Chat Agenda, Dec. 3

Here is the loose agenda for today’s inline docs chat in the #docs channel on SlackSlack Slack is a Collaborative Group Chat Platform The WordPress community has its own Slack Channel at at 20:00 UTC

  1. Private/internal functionality
    We need to come up with a plan and frame of reference for how private/internal functionality should be treated in terms of what’s parsed and what’s not.
  2. Guidelines for `see` tags
    In some coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. DocBlocks, multiple functions are listed. Is that allowed/supported? Do we have adequate coverage for inline `see` tags?
  3. JavaScriptJavaScript JavaScript or JS is an object-oriented computer programming language commonly used to create interactive effects within web browsers. WordPress makes extensive use of JS for a better user experience. While PHP is executed on the server, JS executes within a user’s browser. Docs Standard
    Outstanding discussion topics:
    • List of text editors/IDEs with bundles/extensions for auto-creating JSDoc blocks (@ericlewis) (Sublime w/DocBlockr)
    • List of `@` tags we don’t use in core (Kim to write explanations why)
    • Consistency with the PHPPHP PHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. Doc Standard (sections/format)