Skip to content

Feature Request: Comments #1440

@risen

Description

@risen

I realize this is a bit of an elephant in the room, but I didn't see any discussion about this and wanted to try being a (devil's?) advocate for this feature.

Allowing comments could or would:

  • be a good way to point out incorrect or insufficient documentation, as mentioned in Add "Report" option for incorrect/insufficient documentation #1241.
  • provide more context and background, as a kind of "unofficial" information (stuff that shouldn't be merged into the official docs)
  • explain changes over time (across versions)
  • provide additional examples and gotcha's

I think this was one of the strengths of APIdock, and (from what I remember from 2 decades ago) sites like PHP.net and others.

It'd be nice to be able to be able to comment on Class/Module/Method + version. Maybe some way to do it across versions (#300). In addition, we'd maybe need method-specific pages then.

The downside of course would be having to deal with some kind of authentication, moderation, spam, etc. So while I believe this to be a major added value, I understand this may be out of scope.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions