Skip to content

Commit

Permalink
RUBY-3548: update specification links from RST to MD (#336)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexbevi authored Oct 8, 2024
1 parent d7e5bf1 commit 86ddb75
Show file tree
Hide file tree
Showing 23 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion ext/bson/util.c
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ void rb_bson_generate_machine_id(VALUE rb_md5_class, char *rb_bson_machine_id)
* Generate the next object id.
*
* Specification:
* https://github.com/mongodb/specifications/blob/master/source/objectid.rst
* https://github.com/mongodb/specifications/blob/master/source/bson-objectid/objectid.md
*
* The ObjectID BSON type is a 12-byte value consisting of three different portions (fields):
* * a 4-byte value representing the seconds since the Unix epoch in the highest order bytes,
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/array.rb
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ def to_bson_normalized_value
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# This method recursively invokes +as_extended_json+ with the provided
# options on each array element.
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/binary.rb
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ def as_json(*_args)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
# (default is canonical extended JSON)
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/code.rb
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def as_json(*_args)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
# (default is canonical extended JSON)
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/code_with_scope.rb
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def as_json(*_args)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
# (default is canonical extended JSON)
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/db_pointer.rb
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ def as_json(*_args)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# @return [ Hash ] The extended json representation.
def as_extended_json(**_options)
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/decimal128.rb
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ def as_json(*args)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
# (default is canonical extended JSON)
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/ext_json.rb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
module BSON

# This module contains methods for parsing Extended JSON 2.0.
# https://github.com/mongodb/specifications/blob/master/source/extended-json.rst
# https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md
module ExtJSON

# Parses JSON in a string into a Ruby object tree.
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/float.rb
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def to_bson(buffer = ByteBuffer.new)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# This method returns the float itself if relaxed representation is
# requested and the value is finite, otherwise a $numberDouble hash.
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/hash.rb
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ def to_bson_normalized_value
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# This method recursively invokes +as_extended_json+ with the provided
# options on each hash value.
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/int32.rb
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ def as_json(**options)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# This method returns the integer value if relaxed representation is
# requested, otherwise a $numberInt hash.
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/int64.rb
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ def as_json(**options)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# This method returns the integer value if relaxed representation is
# requested, otherwise a $numberLong hash.
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/integer.rb
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ def to_bson_key
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# This method returns the integer itself if relaxed representation is
# requested, otherwise a $numberInt hash if the value fits in 32 bits
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/max_key.rb
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ def as_json(*_args)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
# (default is canonical extended JSON)
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/min_key.rb
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ def as_json(*_args)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
# (default is canonical extended JSON)
Expand Down
4 changes: 2 additions & 2 deletions lib/bson/object.rb
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def to_bson_normalized_value
end

# Serializes this object to Extended JSON
# (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# Subclasses should override +as_extended_json+ rather than this method.
#
Expand All @@ -75,7 +75,7 @@ def to_extended_json(**options)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# Subclasses should override this method to provide custom serialization
# to Extended JSON.
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/object_id.rb
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def as_json(*_)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# @return [ Hash ] The extended json representation.
def as_extended_json(**_)
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/regexp.rb
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ def as_json(*)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
# (default is canonical extended JSON)
Expand Down
4 changes: 2 additions & 2 deletions lib/bson/symbol.rb
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ def to_bson_normalized_key
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# @return [ Hash ] The extended json representation.
def as_extended_json(**_options)
Expand Down Expand Up @@ -166,7 +166,7 @@ def as_json(*args)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# @return [ Hash ] The extended json representation.
def as_extended_json(**_options)
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/time.rb
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def to_bson(buffer = ByteBuffer.new)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# @note The time is floored to the nearest millisecond.
#
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/timestamp.rb
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ def as_json(*args)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
# (default is canonical extended JSON)
Expand Down
2 changes: 1 addition & 1 deletion lib/bson/undefined.rb
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def as_json(*args)
end

# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
# (default is canonical extended JSON)
Expand Down
2 changes: 1 addition & 1 deletion src/main/org/bson_ruby/GeneratorExtension.java
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ public static IRubyObject resetCounter(final IRubyObject generator, final IRubyO

/**
* Generate the next object id in the sequence, per the ObjectId spec:
* https://github.com/mongodb/specifications/blob/master/source/objectid.rst#specification
* https://github.com/mongodb/specifications/blob/master/source/bson-objectid/objectid.md#specification
*
* @param generator The object id generator.
* @param time The time in seconds.
Expand Down

0 comments on commit 86ddb75

Please sign in to comment.