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.

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

Improve RedirectAttributes reference documentation [SPR-12759] #17356

Closed
spring-issuemaster opened this issue Feb 26, 2015 · 3 comments

Comments

Projects
None yet
2 participants
@spring-issuemaster
Copy link
Collaborator

commented Feb 26, 2015

David Tombs opened SPR-12759 and commented

The use of RedirectAttributes is documented in four places in the reference documentation:

  1. In its bullet in Supported method argument types
  2. In Specifying redirect and flash attributes
  3. In RedirectView
  4. In Using flash attributes

The problem is you have to read (and find) all four sections to fully understand how RedirectAttributes is used, and even what the default behavior is if ignoreDefaultModelOnRedirect is false.

I suggest improving the documentation to eliminate #2 (merging content into #3 and #4) and link to #3 and #4 from #1. This would have saved me about an hour of scratching my head yesterday!

I'm happy to do this myself and create a pull request if others agree.


Affects: 4.1.5

Referenced from: commits b0848db, 463878a

@spring-issuemaster

This comment has been minimized.

Copy link
Collaborator Author

commented Feb 26, 2015

Rossen Stoyanchev commented

Yes it does seem more fragmented than it should be. A pull request with your idea would be much appreciated!

@spring-issuemaster

This comment has been minimized.

Copy link
Collaborator Author

commented Apr 7, 2015

David Tombs commented

Sorry for the delay, here's the PR:

#771

@spring-issuemaster

This comment has been minimized.

Copy link
Collaborator Author

commented Apr 8, 2015

Rossen Stoyanchev commented

Thanks we'll take a look then for 4.2 RC1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.