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

Add documentation comments for public classes and methods #233

Open
suragch opened this issue May 4, 2024 · 2 comments
Open

Add documentation comments for public classes and methods #233

suragch opened this issue May 4, 2024 · 2 comments

Comments

@suragch
Copy link
Contributor

suragch commented May 4, 2024

Description

The website documentation is pretty good. It would also be helpful to have documentation comments for the various public classes and methods in Jaspr. It appears that currently none of the code has doc comments.

Additional Context

I'm familiar with Flutter but not so much with CSS. A lot of the syntax follows HTML and CSS naming conventions, but for someone not familiar with these things, it's a little difficult to understand how styling and other aspects work when reading and exploring the code. For example, what is a flexbox or rem or div or section? I'm sure they make sense to someone from a web dev background but not so much for a Flutter dev. And if I had a web dev background in the first place, I probably wouldn't need to use Jaspr.

If I continue using Jaspr, I might be willing to add documentation comments as I learn what things do. Are you open to PRs for that?

@schultek
Copy link
Owner

schultek commented May 4, 2024

Yes code docs are behind big time 🙈 These really need some love.

PRs would be awesome!

@suragch
Copy link
Contributor Author

suragch commented May 8, 2024

Sorry, I was wrong about none of code having doc comments. I had missed it earlier by not scrolling down far enough in VS Code's documentation preview. However, I did submit PR #234 to add comments for the CSS units that had previously confused me.

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

2 participants