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

Update smbios.md #73

Closed
wants to merge 1 commit into from
Closed

Update smbios.md #73

wants to merge 1 commit into from

Conversation

jgstew
Copy link
Member

@jgstew jgstew commented Oct 22, 2015

No description provided.

@gnawhleinad
Copy link
Contributor

The reference documentation doesn't support an ##Examples section. You could update the description or create a guide with the smbios examples.

@jgstew
Copy link
Member Author

jgstew commented Oct 22, 2015

It wasn't clear to me where to put links for examples

@@ -9,3 +9,7 @@ Returns the smbios structure corresponding to the specified string as defined in
# structure of <smbios> : smbios structure

A property containing information pertaining to an instance of a given smbios structure as defined in the 'Type' entries in the SMBIOS specification. This is implemented as a named iterated property.
Copy link
Contributor

Choose a reason for hiding this comment

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

I haven't seen examples in a reference. Nevertheless, it could end up after the description here, "See examples at https://bigfix.me/analysis/details/2994751".

@gnawhleinad
Copy link
Contributor

create a guide with the smbios examples.

Here are some example guides:

They use:

{% qna %}
Q: versions of files of folder "c:\temp" = "4.5"
E: A singular expression is required.
{% endqna %}

To embed and format the page with relevance clauses.

@briangreenery
Copy link
Contributor

It looks like there's a lot of useful information in there. I'm thinking that it might make sense to add those expressions to the System Information guide, and to also link to that guide from the smbios inspector reference page.

Does that sound good?

@jgstew
Copy link
Member Author

jgstew commented Oct 29, 2015

I think it does make sense in the System Information guide.

In general, I do think it would be useful to have examples in the reference materials.

@briangreenery
Copy link
Contributor

I opened issue #80 for this.

baonhan added a commit that referenced this pull request Oct 17, 2017
Updates dued to Fabio's comments
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

Successfully merging this pull request may close these issues.

3 participants