Skip to content

Some classes missing from the API Ref #370

@ethanbeyer

Description

@ethanbeyer

Forum Post Here: https://processwire.com/talk/topic/16897-missing-api-reference-fieldgroups/

Short description of the issue

The Fieldgroups class is missing from the reference, and I wasn't sure why!

Expected behavior

I would expect that the API Ref Docs page would have API references for every Core Class.

Actual behavior

Several classes are missing.

Also, according to @adrianbj:

There actually seems to be the opposite problem with: http://processwire.com/api/ref/wire-database-backup/ - that page 404s, but is linked to under Core Classes > WireDatabaseBackup in the dropdown.

Optional: Suggestion for a possible fix

I feel like the docs would be easier to parse/navigate if the API Variables were shown alongside the class they were an instance of.

  • Config ($config)
  • Field
  • Fields ($fields)
  • Fieldgroup
  • Fieldgroups ($fieldgroups)
  • Fieldtype
  • HookEvent
  • Inputfield
  • InputfieldWrapper
  • MarkupPagerNav
  • Module
  • Modules ($modules)
  • ...
  • Page ($page)
  • Pages ($pages)
  • ...

I'm also aware of the API Gen reference page (https://processwire.com/apigen/index.html), which is more robust, but a little harder to parse.

I've been saying for a while that I'd love to help the docs get better. As they are now, I think they're pretty good - but things could always improve, and if there is one thing in development I am uber-passionate about, it's documentation!!

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