Closed Bug 1523955 Opened 2 years ago Closed 10 months ago

Summary request ?summary does not work

Categories

(developer.mozilla.org Graveyard :: Code Cleanup, enhancement, P5)

All
Other
enhancement

Tracking

(Not tracked)

RESOLVED WONTFIX

People

(Reporter: jwhitlock, Unassigned)

References

()

Details

(Keywords: in-triage, Whiteboard: [specification][type:bug])

What did you do?

1. Go to https://developer.mozilla.org/en-US/docs/Web/CSS/display
2. Add ?summary to get https://developer.mozilla.org/en-US/docs/Web/CSS/display?summary

What happened?

The full page is displayed

What should have happened?

Just the summary HTML should be displayed

Is there anything else we should know?

This is documented on:

https://developer.mozilla.org/en-US/docs/MDN/Contribute/Tools/Document_parameters

There is code that implements this on the Kuma side:

https://github.com/mozilla/kuma/blob/e5f9459dc34a98ab74530d9ac5652f5f009fb9fd/kuma/wiki/views/document.py#L118-L120

However, it doesn't appear in the final output. A new branch is required, similar to the code to short-circuit for "raw" output:

https://github.com/mozilla/kuma/blob/e5f9459dc34a98ab74530d9ac5652f5f009fb9fd/kuma/wiki/views/document.py#L679-L680

This appears to have been broken for about four years. Another option is to remove the code and the documentation.

This would need to be fixed before bug 1148825, or that bug closed if the feature is removed.

Blocks: 1148825

Note that if you also specify the "raw" parameter, it works as expected.

https://developer.mozilla.org/en-US/docs/Web/CSS/display?summary&raw

Component: Wiki pages → Code Cleanup
Keywords: in-triage
Priority: -- → P5

The summary HTML is available in the page JSON, and is used to populate titles by KumaScript and by other tools:

https://developer.mozilla.org/en-US/docs/Web/CSS/display$json

The triage decision was to not spend time either fixing the code or removing the feature, but instead leave it broken. There is a slight preference to remove the feature, since it is available via $json

MDN Web Docs' bug reporting has now moved to GitHub. From now on, please file content bugs at https://github.com/mdn/sprints/issues/ and platform bugs at https://github.com/mdn/kuma/issues/.
Status: NEW → RESOLVED
Closed: 10 months ago
Resolution: --- → WONTFIX
Product: developer.mozilla.org → developer.mozilla.org Graveyard
You need to log in before you can comment on or make changes to this bug.