Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: Comments #1440

Open
risen opened this issue Mar 20, 2023 · 0 comments
Open

Feature Request: Comments #1440

risen opened this issue Mar 20, 2023 · 0 comments

Comments

@risen
Copy link

risen commented Mar 20, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant