Enhance javadoc for World#setAutoSave method#12088
Conversation
Clarify that disabling auto-save does not stop all saving operations. This addition explicitly mentions that the world will still save on shutdown and explains the intended purpose of the method.
|
Can you check other br usages? Semi certain we put them in their own new like just for visual clarity in source. |
It seems to be very mixed |
|
Pretty sure paragraph tags are the standard for Java (and recommended in the docs), we do seem to use both though. Probably better to use <p>? |
|
ok, hear me out, markdown https://openjdk.org/jeps/467 |
|
Would using |
|
Probably more |
|
|
|
apiNote sounds reasonable Other methods in the class are already using Note so would it be smart to update those docs in a separate PR as well or just leave them be? |
|
I don't think we wanna do general cleanup prs yet, so just leave them be for now. |
|
Alright, so apiNote it is? |
|
Yes |
Clarify that disabling auto-save does not stop all saving operations. This addition explicitly mentions that the world will still save on shutdown and explains the intended purpose of the method.
7 participants
The autosave option has been causing confusion for quite some time now
This change clarifies that disabling auto-save does not stop all saving operations.
This addition explicitly mentions that the world will still save on shutdown and explains the intended purpose of the method.