You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "tustvold (via GitHub)" <gi...@apache.org> on 2023/03/30 08:34:50 UTC

[GitHub] [arrow-rs] tustvold opened a new pull request, #3978: Convert string_to_timestamp_nanos to doctest

tustvold opened a new pull request, #3978:
URL: https://github.com/apache/arrow-rs/pull/3978

   # Which issue does this PR close?
   
   <!--
   We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123.
   -->
   
   Closes #.
   
   # Rationale for this change
    
   <!--
   Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
   Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
   -->
   
   
   As by @byteink in https://github.com/apache/arrow-rs/pull/3977 these docs were previously wrong. This PR converts them to a doctest to guarantee correctness going forward.
   
   # What changes are included in this PR?
   
   <!--
   There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
   -->
   
   # Are there any user-facing changes?
   
   
   <!--
   If there are user-facing changes then we may require documentation to be updated before approving the PR.
   -->
   
   <!---
   If there are any breaking changes to public APIs, please add the `breaking change` label.
   -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-rs] alamb commented on a diff in pull request #3978: Convert string_to_timestamp_nanos to doctest

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #3978:
URL: https://github.com/apache/arrow-rs/pull/3978#discussion_r1153496814


##########
arrow-cast/src/parse.rs:
##########
@@ -264,8 +264,17 @@ pub fn string_to_datetime<T: TimeZone>(
 /// This function interprets string without an explicit time zone as timestamps
 /// relative to UTC, see [`string_to_datetime`] for alternative semantics
 ///
-/// For example, both `1997-01-31 09:26:56.123Z`, `1997-01-31T09:26:56.123`,
-/// and `1997-01-31T14:26:56.123+05:00` will be parsed as the same value
+/// In particular:
+///
+/// ```
+/// # use arrow_cast::parse::string_to_timestamp_nanos;
+/// let a = string_to_timestamp_nanos("1997-01-31 09:26:56.123Z").unwrap();

Review Comment:
   ```suggestion
   /// // Note all three of thee timestamps are parsed as the same value
   /// let a = string_to_timestamp_nanos("1997-01-31 09:26:56.123Z").unwrap();
   ```



##########
arrow-cast/src/parse.rs:
##########
@@ -264,8 +264,17 @@ pub fn string_to_datetime<T: TimeZone>(
 /// This function interprets string without an explicit time zone as timestamps
 /// relative to UTC, see [`string_to_datetime`] for alternative semantics
 ///
-/// For example, both `1997-01-31 09:26:56.123Z`, `1997-01-31T09:26:56.123`,
-/// and `1997-01-31T14:26:56.123+05:00` will be parsed as the same value
+/// In particular:

Review Comment:
   ❤️ 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-rs] tustvold merged pull request #3978: Convert string_to_timestamp_nanos to doctest

Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold merged PR #3978:
URL: https://github.com/apache/arrow-rs/pull/3978


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [arrow-rs] alamb commented on a diff in pull request #3978: Convert string_to_timestamp_nanos to doctest

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #3978:
URL: https://github.com/apache/arrow-rs/pull/3978#discussion_r1153496814


##########
arrow-cast/src/parse.rs:
##########
@@ -264,8 +264,17 @@ pub fn string_to_datetime<T: TimeZone>(
 /// This function interprets string without an explicit time zone as timestamps
 /// relative to UTC, see [`string_to_datetime`] for alternative semantics
 ///
-/// For example, both `1997-01-31 09:26:56.123Z`, `1997-01-31T09:26:56.123`,
-/// and `1997-01-31T14:26:56.123+05:00` will be parsed as the same value
+/// In particular:
+///
+/// ```
+/// # use arrow_cast::parse::string_to_timestamp_nanos;
+/// let a = string_to_timestamp_nanos("1997-01-31 09:26:56.123Z").unwrap();

Review Comment:
   ```suggestion
   /// // Note all three of these timestamps are parsed as the same value
   /// let a = string_to_timestamp_nanos("1997-01-31 09:26:56.123Z").unwrap();
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org