plone / plone/documentation

Inconsistent case suggests wrong view name in contentlisting docs

Open
#1,083 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

33 needs: docs 34 needs: tests 42 lvl: moderate 99 tag: Plone 6.x
Dominant language
Makefile
Stars
106
Forks
190
Avg merge
3d 2h
Merged PRs (30d)
1

Description

  • I'm submitting a ...

    • [✓] bug report
    • feature request
  • Do you want to request a feature or report a bug?

Bug.

  • What is the current behavior?

The document for the plone.app.contentlisting view uses "contentListing" (with a capital L) prominently in headings and throughout the documentation. Combined with the fact that @@folderListing is the backward-compatible view name (also with a capital L), this suggests that @@contentListing is in fact the view name for retrieving listings of content.

But it's not: it's @@contentlisting with a lowercase l.

  • If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem
  1. Read https://5.docs.plone.org/external/plone.app.contentlisting/README.html
  2. Note that there are 7 occurrences of contentListing with a capital L.
  • What is the expected behavior?

There should be zero.

  • What is the motivation / use case for changing the behavior?

User confusion. I personally spent way too much time trying to debug why upgrading an older add-on to use @@contentlisting from getFolderContents or other direct-portal_catalog queries wasn't working when I finally noticed the difference in case.

  • Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)

Thanks to @jensens for pushing me to submit this report here rather than moan about it on Twitter.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked plone.app.contentlisting README and search for every occurrence of contentListing with an uppercase L. Update the documentation so the view name is consistently contentlisting, then verify that no uppercase-L occurrences remain.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.