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

Development Documentation not in Sync with Development Branch #34701

Closed
richardscollin opened this issue Jul 15, 2016 · 8 comments
Closed

Development Documentation not in Sync with Development Branch #34701

richardscollin opened this issue Jul 15, 2016 · 8 comments
Labels
Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation P1 Priority 1 severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around
Milestone

Comments

@richardscollin
Copy link
Contributor

Description of Issue/Question

The salt development documentation is not in sync with the development repo.

See:

https://docs.saltstack.com/en/develop/ref/modules/all/salt.modules.system.html

 salt.modules.system.get_system_date_time(utc=None)

    Get the system date/time.
    Parameters: utc (bool) -- A Boolean that indicates if the output timezone is UTC.
    Returns:    Returns the system time in YYYY-MM-DD hh:mm:ss format.
    Return type:    str

https://github.com/saltstack/salt/blob/develop/salt/modules/system.py

    Get the system time.
    :param str utc_offset: The utc offset in 4 digit (+0600) format with an
    optional sign (+/-).  Will default to None which will use the local
    timezone. To set the time based off of UTC use "'+0000'". Note: if being
    passed through the command line will need to be quoted twice to allow
    negative offsets.
    :return: Returns the system time in HH:MM AM/PM format.
    :rtype: str
@richardscollin
Copy link
Contributor Author

@jfindlay

@rallytime
Copy link
Contributor

@richardscollin I suspect there might be an error in the develop docs, and sphinx isn't building the most recent version.

@jacobhammons Can you take a look?

@rallytime rallytime added Documentation Relates to Salt documentation Bug broken, incorrect, or confusing behavior severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around P1 Priority 1 labels Jul 15, 2016
@rallytime rallytime added this to the Approved milestone Jul 15, 2016
@jacobhammons
Copy link
Contributor

@rallytime you are right, the develop docs are behind right now due to a build error. I submitted a PR yesterday to fix this in 2015.8, so develop will build again after it is merged forward.

@rallytime
Copy link
Contributor

@jacobhammons Oh! Is the fix in #34616? I merged that forward a couple of days ago in #34624. Is it possible there is a different build error in develop?

@jacobhammons
Copy link
Contributor

@rallytime you did indeed, there must be another error. I'll take a look.

@rallytime
Copy link
Contributor

Ok! Thank you!

@jacobhammons
Copy link
Contributor

develop docs are building again, there was a sync issue on the build server.

@rallytime
Copy link
Contributor

Thanks @jacobhammons! Those look correct now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation P1 Priority 1 severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around
Projects
None yet
Development

No branches or pull requests

3 participants