Opened 9 months ago
Last modified 9 months ago
#35261 closed Bug
Media Path as Objects - Documentation fix and usage example — at Initial Version
| Reported by: | Leandro de Souza | Owned by: | nobody |
|---|---|---|---|
| Component: | Documentation | Version: | 4.1 |
| Severity: | Normal | Keywords: | Documentation, Media |
| Cc: | Leandro de Souza | Triage Stage: | Ready for checkin |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
[Related conversation on forum](https://forum.djangoproject.com/t/media-path-as-objects/28470)
Issue: The documentation for [Media Path as Objects](https://docs.djangoproject.com/en/4.1/topics/forms/media/#paths-as-objects) uses an incorrect attribute (rel) on a script tag, source: [HTML attribute: rel - HTML: HyperText Markup Language | MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel). Quoted from the source:
The rel attribute defines the relationship between a linked resource and the current document. Valid on <link>, <a>, <area>, and <form>, the supported values depend on the element on which the attribute is found.
Another thing is that the example given for the usage of this new feature added on 4.1 is not really that useful. The JSPath class in the example is just a hardcoded script tag that illustrates how to use the __str__ method to render the tag.
I believe that adding a more useful example would add more "bright" to the value that this feature has providen: adding flexibility. Some usage examples of this new feature has been added to the conversation on the forum.
I would be happy to work on this patch/fix.