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

#9133

Closed
Redageddon opened this issue May 27, 2020 · 3 comments
Closed

#9133

Redageddon opened this issue May 27, 2020 · 3 comments

Comments

@Redageddon
Copy link

Redageddon commented May 27, 2020

No description provided.

@bdach
Copy link
Collaborator

bdach commented May 27, 2020

We are aware of a lack of documentation in some areas (in fact ppy/osu-framework#3233 is tracking precisely that). If there are areas you'd like to be covered by documentation in particular feel free to drop a comment there. However note that many public components have xmldoc in source and usage examples in visual tests.

Closing as duplicate.

@bdach bdach closed this as completed May 27, 2020
@peppy
Copy link
Member

peppy commented May 28, 2020

Please also note that this is the wrong repository for suggesting this. You may, as such, have missed the documentation at https://github.com/ppy/osu-framework/wiki and the template projects that are made to get you started.

Also it would be handy to know which areas you found lacking in documentation so we can potentially focus on improving that area. Please follow-up in ppy/osu-framework#3233.

@peppy
Copy link
Member

peppy commented May 28, 2020

We already add documentation where the code doesn't explain itself. We know we are missing higher level documentation, though, showing the flow of larger interactions (like the editor as a whole) which is our focus.

You really need to provide at least one example of where you expect code-level documentation so we can assess whether it's in line with our expectations.

@Redageddon Redageddon changed the title Add documentation Dec 14, 2020
@Redageddon Redageddon changed the title Dec 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants