I'm wondering if it would be possible to get some descriptions added to the method references on the wiki. Looking through the references section, I see examples of methods and how to use them, which is great, but no descriptions of what they do. I understand that code should be self documenting, but as an outsider to the project, I don't know the difference between RecipeViewerEvents.removeEntries and RecipeViewerEvents.removeEntriesCompletely.
I see that some of the methods have extra descriptions, like RecipeViewerEvents.addInformation has an image showing the result of the method call. It would be really helpful if the expected arguments were clearly documented as well, such as in a table listing their expected types, default values and a brief description. I know a lot of the arguments to these methods should be self explanatory, but some of them aren't, so having a standard for documentation would make a huge difference for those just looking for a quick reference. The tutorials on the wiki are fantastic, but they're not very searchable. Having more detail in the actual reference section would be enormously helpful.
Thank you!
I'm wondering if it would be possible to get some descriptions added to the method references on the wiki. Looking through the references section, I see examples of methods and how to use them, which is great, but no descriptions of what they do. I understand that code should be self documenting, but as an outsider to the project, I don't know the difference between
RecipeViewerEvents.removeEntriesandRecipeViewerEvents.removeEntriesCompletely.I see that some of the methods have extra descriptions, like
RecipeViewerEvents.addInformationhas an image showing the result of the method call. It would be really helpful if the expected arguments were clearly documented as well, such as in a table listing their expected types, default values and a brief description. I know a lot of the arguments to these methods should be self explanatory, but some of them aren't, so having a standard for documentation would make a huge difference for those just looking for a quick reference. The tutorials on the wiki are fantastic, but they're not very searchable. Having more detail in the actual reference section would be enormously helpful.Thank you!