Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Code example has callout from a different code example #29505

Closed
dfjfj opened this issue Nov 17, 2022 · 6 comments
Closed

Code example has callout from a different code example #29505

dfjfj opened this issue Nov 17, 2022 · 6 comments
Assignees
@sbrannen
Labels
type: documentation A documentation task
Milestone
6.0.1

Comments

@dfjfj
Copy link

dfjfj commented Nov 17, 2022 •
edited by sbrannen
Loading

Affects: Spring Framework 6.0.0

There is a small problem in the @ModelAttribute section of the reference manual: https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-modelattrib-method-args

There are a few redundant remarks such as : "Adding a BindingResult next to the @ModelAttribute." etc.

I think this should be easy to find and modify, thanks.
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Nov 17, 2022
@snicoll
Copy link
Member

snicoll commented Nov 17, 2022

@dfjfj sorry, but I don't understand the problem you're trying to report. What do you mean by "redundant remark"?

@snicoll snicoll added the status: waiting-for-feedback We need additional information before we can continue label Nov 17, 2022
@dfjfj
Copy link
Author

dfjfj commented Nov 17, 2022

Sorry for the language trouble, please check the picture.
incorrect:
屏幕截图 2022-11-17 153638
correct:
屏幕截图 2022-11-17 154229

@snicoll
Copy link
Member

snicoll commented Nov 17, 2022

@dfjfj I see it now. Thanks very much.

@spring-projects-issues spring-projects-issues added status: feedback-provided Feedback has been provided and removed status: waiting-for-feedback We need additional information before we can continue labels Nov 17, 2022
@dfjfj
Copy link
Author

dfjfj commented Nov 17, 2022

You're welcome, a little effort.

@dfjfj dfjfj closed this as completed Nov 17, 2022
@bclozel bclozel reopened this Nov 17, 2022
@snicoll snicoll changed the title The documentation for version 6.0.0 describes the problem Documentation has callout of another section Nov 17, 2022
@snicoll
Copy link
Member

snicoll commented Nov 17, 2022

That looks like a bug in the asciidoc rendering as the callout isn't in the source. I've noticed that switching to the Kotlin sample makes it go away.

@sbrannen sbrannen added the type: documentation A documentation task label Nov 17, 2022
@sbrannen sbrannen added this to the 6.0.1 milestone Nov 17, 2022
@sbrannen sbrannen removed status: waiting-for-triage An issue we've not yet triaged or decided on status: feedback-provided Feedback has been provided labels Nov 17, 2022
@sbrannen sbrannen changed the title Documentation has callout of another section Code example has callout from a different code example Nov 17, 2022
sbrannen added a commit that referenced this issue Nov 17, 2022
@sbrannen
Work around code example callout bug
ac7d428 
This commit adds callouts to two sets of Java/Kotlin code examples in
the @ModelAttribute section for Web MVC in order to work around the
"Code example has callout from a different code example" bug.

This also aligns the Web MVC examples with the WebFlux examples.

As a side note, the bug can also be seen in the WebFlux documentation
if the callouts are removed from the first Java/Kotlin examples in the
@ModelAttribute section for WebFlux. Thus it appears to be a general
issue related to examples within a given section of the documentation
when some examples have callouts and others do not, likely due to a bug
in the Javascript that provides this feature.

See gh-29505
@sbrannen
Copy link
Member

sbrannen commented Nov 17, 2022 •
edited
Loading

I have pushed a workaround for this bug in ac7d428.

However, as mentioned in the commit message this appears to be a general bug that still needs to be addressed. As @snicoll pointed out elsewhere, this is likely an issue with the Javascript that supports this feature.

To address this, I have opened spring-io/spring-asciidoctor-backends#68.

In light of that, I am closing this issue.

@sbrannen sbrannen mentioned this issue Nov 17, 2022
Closed
@sbrannen sbrannen self-assigned this Nov 17, 2022
@sbrannen sbrannen mentioned this issue Nov 20, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sbrannen sbrannen

Labels
type: documentation A documentation task
Projects
None yet
Milestone
6.0.1
Development

No branches or pull requests
5 participants
@bclozel @sbrannen @snicoll @spring-projects-issues @dfjfj