fix #462

gagolews · Jun 28, 2022 · 3eb2798 · 3eb2798
1 parent 1c84d63
commit 3eb2798
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 6 deletions.
diff --git a/NEWS b/NEWS
@@ -12,8 +12,8 @@
 
 * [BUGFIX] #480: Using `Rf_isNull` instead of isNull`.
 
-* [DOCUMENTATION] #462... That the `numeric=TRUE` collator
-    does not handle negative numbers correctly is not mentioned in the manual.
+* [DOCUMENTATION] #462: That the `numeric=TRUE` collator
+    does not handle negative numbers correctly is now mentioned in the manual.
 
 
 ...    checkRd: (-1) stri_trans_nf.Rd:74: Escaped LaTeX specials: \#

diff --git a/R/opts.R b/R/opts.R
@@ -1,7 +1,7 @@
 # kate: default-dictionary en_US
 
 ## This file is part of the 'stringi' package for R.
-## Copyright (c) 2013-2021, Marek Gagolewski <https://www.gagolewski.com>
+## Copyright (c) 2013-2022, Marek Gagolewski <https://www.gagolewski.com>
 ## All rights reserved.
 ##
 ## Redistribution and use in source and binary forms, with or without
@@ -77,7 +77,8 @@
 #' @param numeric single logical value;
 #' when turned on, this attribute generates a collation key for
 #' the numeric value of substrings of digits;
-#' this is a way to get '100' to sort AFTER '2'
+#' this is a way to get '100' to sort AFTER '2';
+#' note that negative numbers will not be ordered properly
 #' @param ... [DEPRECATED] any other arguments passed to this function
 #'     generate a warning; this argument will be removed in the future
 #'

diff --git a/devel/sphinx/weave/collation.Rmd b/devel/sphinx/weave/collation.Rmd
@@ -234,7 +234,7 @@ we play with some of them.
 | `locale`              | a string specifying the locale to use; `NULL` (default) or `""` for the current default locale as indicated by `stri_locale_get()`                                                                                                                                                                                                                                       |
 | `strength`            | an integer in *{1,2,3,4}* defining collation strength; 1 for the most permissive collation rules, 4 for the strictest ones; defaults to 3                                                                                                                                                                                                                              |
 | `uppercase_first`     | logical; `NA` (default) orders upper and lower case letters in accordance to their tertiary weights, `TRUE` forces upper case letters to sort before lower case letters, `FALSE` does the opposite                                                                                                                                                                       |
-| `numeric`             | logical; if `TRUE`, a collation key for the numeric value of substrings of digits is generated; this is a way to make `"100"` ordered after `"2"`; defaults to `FALSE`                                                                                                                                                                                                   |
+| `numeric`             | logical; if `TRUE`, a collation key for the numeric value of substrings of digits is generated; this is a way to make `"100"` ordered after `"2"`; however, negative numbers are not ordered correctly; defaults to `FALSE`                                                                                                                                                                                                   |
 | `case_level`          | logical; if `TRUE`, an extra case level (positioned before the third level) is generated; defaults to `FALSE`                                                                                                                                                                                                                                                            |
 | `normalisation`       | logical; if `TRUE`, then an incremental check is performed to see whether input data are in the FCD ("fast C or D") form; if data are not in the FCD form, the incremental NFD normalisation is performed, see {ref}`Sec:normalisation`; defaults to `FALSE`                                                                                                             |
 | `alternate_shifted`   | logical; if `FALSE` (default), all code points with non-ignorable primary weights are handled in the same way; `TRUE` causes the code points with primary weights that are less than or equal to the variable top value to be ignored on the primary level and moved to the quaternary level; this can be used to, e.g., ignore punctuation, see the examples provided   |

diff --git a/man/stri_opts_collator.Rd b/man/stri_opts_collator.Rd