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

Variables documentation does not mention types of Warehouse objects #498

Open
ghost opened this issue Jun 11, 2017 · 5 comments
Open

Variables documentation does not mention types of Warehouse objects #498

ghost opened this issue Jun 11, 2017 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@ghost
Copy link

ghost commented Jun 11, 2017

This one had me stumped for very very long! Neither the docs or the examples made this clear at all, I didn't find it until looking in the troubleshooting section. It could reasonably be as simple as the paranthesis notes regarding the datetime objects.

@NoahDragon NoahDragon added the documentation Improvements or additions to documentation label Jun 14, 2017
@NoahDragon
Copy link
Member

Could you please create a PR for this documentation change, as I'm not sure exactly the issue is?

@ghost
Copy link
Author

ghost commented Jun 15, 2017

I'm really busy until thursday next week, so I'm afraid I can't for now (although I'll be sure to once I resume development, if still needed).

Check https://hexo.io/docs/variables.html#Page-Variables

Look the page.updated and page.date entries, which note that they're Moment.js objects. The same should be done with Warehouse objects. In fact it might be best to add a type field for all variables.

@NoahDragon
Copy link
Member

Thanks for the info. I will take a look.

@ghost
Copy link
Author

ghost commented Jul 7, 2017

Addressed partially in #510. It's on the main branch now, so it's visible on the live page. Some placeholders for what I didn't figure out are present in the form of ???, most of these being some kind of Warehouse objects, or arrays of them, I believe. Warehouse objects should point to the Warehouse documentation, much like Moment.js objects do.

Additionally I'm not 100% sure if everything I wrote is correct, so feel free to double check!

@NoahDragon
Copy link
Member

@Krakob Thank you. I think I will definitely look into it when I have time, I promise. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant