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.

Sign up for GitHub

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

Jump to bottom

docs: Improve internal API documentation and update comment format to Yard #47

Closed
jaredcwhite opened this issue May 14, 2020 · 6 comments
Closed

docs: Improve internal API documentation and update comment format to Yard #47

jaredcwhite opened this issue May 14, 2020 · 6 comments
Assignees
@jaredcwhite @KonnorRogers
Labels
documentation Improvements or additions to documentation
Milestone
0.21 "Broughton B...

Comments

@jaredcwhite
Copy link
Member

jaredcwhite commented May 14, 2020 •
edited
Loading

UPDATE: see #283

Looking through the generated docs from Yard:
https://rubydoc.info/gems/bridgetown-core/

Right now any useful information contained therein is very spotty and some files have no documentation whatsoever. We should prioritize incremental progress towards a fairly complete set of documentation around the core set of Bridgetown objects. Not as worried about ancillary objects like a string utility here or a tag there.
@jaredcwhite jaredcwhite added the documentation Improvements or additions to documentation label May 14, 2020
@jaredcwhite jaredcwhite changed the title docs: Improve internal API documentation with a nod toward Yard docs docs: Improve internal API documentation and update comment format to Yard Jun 30, 2020
@jaredcwhite
Copy link
Member Author

Definitely want to make sure we're providing comprehensive hover info for editors using https://solargraph.org

@jaredcwhite
Copy link
Member Author

Also I'm assigning to you @ParamagicDev but obviously I can help out as well 😃

@KonnorRogers
Copy link
Member

@jaredcwhite what branch would you like me to fork off of? Main?

@jaredcwhite
Copy link
Member Author

@ParamagicDev yep, that's fine

@KonnorRogers KonnorRogers mentioned this issue Jul 2, 2020
Merged
@jaredcwhite jaredcwhite self-assigned this Oct 25, 2020
@jaredcwhite jaredcwhite added this to the 0.18.0 "Taylor Street" milestone Oct 25, 2020
@jaredcwhite
Copy link
Member Author

Some improvements in #171, including switching YARD's text processing to Markdown format

@jaredcwhite jaredcwhite mentioned this issue Dec 10, 2020
Closed
@jaredcwhite jaredcwhite modified the milestones: 0.19.0 "TBD", 0.20 Jan 3, 2021
@jaredcwhite
Copy link
Member Author

Continuing to make progress in 0.20…still more to do though! 🤪

@jaredcwhite jaredcwhite mentioned this issue Apr 12, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jaredcwhite jaredcwhite

@KonnorRogers KonnorRogers

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.21 "Broughton Beach"
Development

No branches or pull requests
2 participants
@jaredcwhite @KonnorRogers