Add circshift! changes to docs?

[cormullion]

On Julia v1.8rc1

julia> circshift!(collect(1:10), 1)
10-element Vector{Int64}:
  2
  3
  4
  5
  6
  7
  8
  9
 10
  1

On Julia v1.7.0

julia> circshift!(collect(1:10), 1)
ERROR: ^[[AMethodError: no method matching circshift!(::Vector{Int64}, ::Int64)
Closest candidates are:
  circshift!(::AbstractArray, ::Any, ::Tuple{}) at /Applications/Julia-1.7.app/Contents/Resources/julia/share/julia/base/multidimensional.jl:1104
  circshift!(::AbstractArray{T, N}, ::Any, ::Tuple{Vararg{Integer, N}} where N) where {T, N} at /Applications/Julia-1.7.app/Contents/Resources/julia/share/julia/base/multidimensional.jl:1116
  circshift!(::AbstractArray, ::Any, ::Any) at /Applications/Julia-1.7.app/Contents/Resources/julia/share/julia/base/multidimensional.jl:1124
  ...
Stacktrace:
 [1] top-level scope
   @ REPL[1]:1

Perhaps the documentation should note something about the change?

[fredrikekre]

Added in #42678

[ehehela]

Sorry to bring this up again, but I just wanted to mention that the documentation of circshift!(a, shift) with AbstractVector is still missing. The current documentation only covers the usage of circshift!(dest, src, shifts), which is not specifically tailored for AbstractVector (see docs). The usage of circshift!(a, shift) still remains undocumented.

julia/base/abstractarray.jl

Lines 3657 to 3668 in 8f5b7ca

	## 1-d circshift ##
	function circshift!(a::AbstractVector, shift::Integer)
	n = length(a)
	n == 0 && return a
	shift = mod(shift, n)
	shift == 0 && return a
	l = lastindex(a)
	reverse!(a, firstindex(a), l-shift)
	reverse!(a, l-shift+1, lastindex(a))
	reverse!(a)
	return a
	end