Opened 5 years ago

Last modified 4 years ago

#15091 new Bug

Serializer docs contain nothing on how to use a custom encoder

Reported by: knurpsburps Owned by: nobody
Component: Documentation Version: 1.2
Severity: Normal Keywords:
Cc: jschrewe@…, kmike84@… Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

I'm trying to use a custom json encoder and the docs tell me how to write one. Sdly they are missing any clue on how to use this encoder. At least I haven't found anything in the docs.

Change History (7)

comment:1 follow-up: Changed 5 years ago by gabrielhurley

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

I'm guessing this is in reference to the serialization topic guide (particularly the last few paragraphs of the JSON section).

I'll agree there probably should be a section in the topic guide on installing/using your own serializer. Relevant information in the source code and in the settings reference.

comment:2 in reply to: ↑ 1 Changed 5 years ago by knurpsburps

  • Cc jschrewe@… added

Replying to gabrielhurley:

I'm guessing this is in reference to the serialization topic guide (particularly the last few paragraphs of the JSON section).

Yes.

I'll agree there probably should be a section in the topic guide on installing/using your own serializer. Relevant information in the source code and in the settings reference.

So, from what I read from these links is that in order to use a different encoder a new serializer must be used? The documentation in that section seemed to imply that encoders could be changed without that. But maybe that's just hope on my part.

But anyway, I think at least a hint in the docs would make this a lot clearer.

comment:3 Changed 5 years ago by knurpsburps

  • Cc jschrewe@… added; jschrewe@… removed

comment:4 Changed 4 years ago by kmike

  • Cc kmike84@… added

comment:5 Changed 4 years ago by jaddison

  • Severity set to Normal
  • Type set to Bug

comment:6 Changed 4 years ago by aaugustin

  • UI/UX unset

Change UI/UX from NULL to False.

comment:7 Changed 4 years ago by aaugustin

  • Easy pickings unset

Change Easy pickings from NULL to False.

Note: See TracTickets for help on using tickets.
Back to Top