message_differencer.h

[jokrefta]

In message_differencer.h in the section "class MessageDifferencer::Reporter",

It currently appears as follows:

For example, given following proto, if both baz and quux are changed. foo {

bar {
  baz: 1
  quux: 2
}

} ReportModified will be invoked with following order:

Notice there is a stray foo { and } that should be part of the code block but aren't.

[Logofile]

Are you talking about here? I'm not seeing what you're seeing.

[jokrefta]

I was referring to the documentation page: https://protobuf.dev/reference/cpp/api-docs/google.protobuf.util.message_differencer/

[Logofile]

Our API doc generation script is not working, currently. I hope we can address this soon so we can regenerate all of the topics to bring them current. I'll update this one directly in the meantime (though editing generated content is of course almost always a terrible idea!).

[jokrefta]

I'm guessing the generation treats the doc comments as markdown-like, where leading spaces before a line signify a code block? If so, I'm guessing that section in the source would need to be indented a couple spaces to generate correctly.

[Logofile]

I looked at the source, and it's definitely wonky. It was generated before I joined the team, so I don't have any history on why it was wonky. I've updated it in the source, and it should be published here within the next two weeks.