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 YARD for inline documentation #1634

Merged
merged 1 commit into from
Aug 14, 2020
Merged

Conversation

nickcharlton
Copy link
Member

  • Ignores the doc/ directory so we don't commit the generated docs,
  • Includes the existing docs as files, plus the CHANGELOG, CoC, and
    LICENSE.

Fixes: #1605.

@nickcharlton nickcharlton marked this pull request as draft May 1, 2020 16:19
@nickcharlton
Copy link
Member Author

Something to figure out next: Screenshot 2020-05-01 at 17 20 55

  • Listing the existing docs better,
  • The YAML front-matter we introduced recently now does look a bit weird,
  • We should work out a short-list of methods to document

@pablobm
Copy link
Collaborator

pablobm commented Jun 1, 2020

Would it make sense to merge this and create new issues for the future tasks?

@nickcharlton
Copy link
Member Author

I think so yeah. I'll do a final pass this Friday and then extract new issues for everything I can think of.

@nickcharlton nickcharlton added documentation how to use administrate, examples and common usage feature new functionality that’s not yet implemented labels Jun 25, 2020
* Ignores the `doc/` directory so we don't commit the generated docs,
* Includes the existing docs as files, plus the CHANGELOG, CoC, and
  LICENSE.

Fixes: #1605.
@nickcharlton nickcharlton force-pushed the nc-add-inline-documentation branch from fd1b37d to 859e908 Compare August 14, 2020 11:54
@nickcharlton
Copy link
Member Author

I'm going to merge this now so that we can have it linked to from RubyDoc.info.

I'm expecting that some documentation work we're also doing will solve the YAML frontmatter problem I mentioned previously and that improvements to the inline docs can be done bit by bit as we see things which are valuable.

@nickcharlton nickcharlton marked this pull request as ready for review August 14, 2020 12:07
@nickcharlton nickcharlton merged commit 6d726a1 into master Aug 14, 2020
@nickcharlton nickcharlton deleted the nc-add-inline-documentation branch August 14, 2020 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation how to use administrate, examples and common usage feature new functionality that’s not yet implemented
Projects
None yet
Development

Successfully merging this pull request may close these issues.

We should document the existance of new_resource
2 participants