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

docs(variables): fix returned type #1568

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

noraj
Copy link
Contributor

@noraj noraj commented Nov 22, 2020

fix #1567, hexojs/hexo#3038

Check List

Please read and check followings before submitting a PR.

  • I want to publish my theme on Hexo official website.
    • I have read the theme publishing doc.
    • name is unique.
    • link URL is correct.
    • preview URL is correct.
    • preview URL web site is rendered correctly.
    • Add a screenshot to source/themes/screenshots.
    • Screenshot filename is same as value of name.
    • Screenshot size is 800 * 500.
    • Screenshot file format is png.
  • I want to publish my plugin on Hexo official website.
  • Others (Update, fix, translation, etc...)
    • Languages:
    • en English
    • ko Korean
    • pt-br Brazilian Portuguese
    • ru Russian
    • th Thai
    • zh-cn simplified Chinese
    • zh-tw traditional Chinese

Tell me if it's right before I modify other langs

`site.categories` | All categories | `array` of ???
`site.tags` | All tags | `array` of ???

[queryo]:http://hexojs.github.io/warehouse/Query.html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[queryo]:http://hexojs.github.io/warehouse/Query.html
[queryo]: https://hexojs.github.io/warehouse/classes/query.Query.html

`site.posts` | All posts | `array` of `post` objects
`site.pages` | All pages | `array` of `page` objects
`site.posts` | All posts | [Query][queryo] object
`site.pages` | All pages | [Query][queryo] object
`site.categories` | All categories | `array` of ???
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

site.categories and site.tags are also Query object. Documentation for other languages can also be updated

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@uiolee uiolee changed the title variables: fix returned type docs(variables): fix returned type Sep 2, 2023
@uiolee uiolee added Docs source/docs en lang: en labels Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs source/docs en lang: en
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Site variables documentation is wrong
3 participants