junrushao opened a new pull request, #177: URL: https://github.com/apache/tvm-ffi/pull/177
This PR does two things to the doc: - **Change A**. Skip member methods of builtin classes; - **Change B**. Clearly mark which base class a method inherits from. **Change A**. To give an example, `tvm_ffi.dtype`, as a subclass of Python's native `str`, is shown to have the following methods inherited from `str`: | Method | Description | |---|---| | `capitalize()` | Return a capitalized version of the string. | | `casefold()` | Return a version of the string suitable for caseless comparisons. | | `center(width[, fillchar])` | Return a centered string of length `width`. | | `count(sub[, start[, end]])` | Return the number of non-overlapping occurrences of substring `sub` in `S[start:end]`. | | `encode([encoding, errors])` | Encode the string using the codec registered for `encoding`. | | `endswith(suffix[, start[, end]])` | Return `True` if the string ends with the specified `suffix`, `False` otherwise. | | `expandtabs([tabsize])` | Return a copy where all tab characters are expanded using spaces. | | `find(sub[, start[, end]])` | Return the lowest index in `S` where substring `sub` is found, such that `sub` is contained within `S[start:end]`. | | `format(*args, **kwargs)` | Return a formatted version of the string, using substitutions from `args` and `kwargs`. | | `format_map(mapping, /)` | Return a formatted version of the string, using substitutions from `mapping`. | , which adds quite a lot of noise because they are irrelevant to `dtype` usecases. **Change B**. For inherited methods, e.g. `Tensor.same_as` which is from `Object.same_as` - currently it's not clickable and doesn't have a detailed documentation for it, which is quite inconvenient. This PR replaces its description to: ``` Defined in [Object](link/to/reference/python/generated/tvm_ffi.Object.html#tvm_ffi.Object).` ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
