## Description from docstring { #description-from-docstring }

As descriptions tend to be long and cover multiple lines, you can declare the *path operation* description in the function <abbr title="a multi-line string as the first expression inside a function (not assigned to any variable) used for documentation">docstring</abbr> and **FastAPI** will read it from there.

{* ../../docs_src/path_operation_advanced_configuration/tutorial003.py hl[6] *}

## Advanced description from docstring { #advanced-description-from-docstring }

You can limit the lines used from the docstring of a *path operation function* for OpenAPI.

Adding an `\f` (an escaped "form feed" character) causes **FastAPI** to truncate the output used for OpenAPI at this point.

It is a plug-in for many frameworks (and there's a plug-in for Starlette too).

The way it works is that you write the definition of the schema using YAML format inside the docstring of each function handling a route.

And it generates OpenAPI schemas.

That's how it works in Flask, Starlette, Responder, etc.

* Add support for truncating docstrings from *path operation functions*.
    * New docs at [Advanced description from docstring](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#advanced-description-from-docstring).
    * PR [#556](https://github.com/tiangolo/fastapi/pull/556) by [@svalouch](https://github.com/svalouch).

  }

  /**
   * Returns a human-readable string representation of {@code type}.
   *
   * <p>The format is subject to change.
   */
  static String toString(Type type) {
    return (type instanceof Class) ? ((Class<?>) type).getName() : type.toString();
  }

  static @Nullable Type getComponentType(Type type) {
    checkNotNull(type);
    AtomicReference<@Nullable Type> result = new AtomicReference<>();

  }

  /**
   * Returns a human-readable string representation of {@code type}.
   *
   * <p>The format is subject to change.
   */
  static String toString(Type type) {
    return (type instanceof Class) ? ((Class<?>) type).getName() : type.toString();
  }

  static @Nullable Type getComponentType(Type type) {
    checkNotNull(type);
    AtomicReference<@Nullable Type> result = new AtomicReference<>();

        updateConfigListenerMap.put("PathMapping", () -> Integer.toString(ComponentUtil.getPathMappingHelper().load()));
        updateConfigListenerMap.put("RelatedContent", () -> Integer.toString(ComponentUtil.getRelatedContentHelper().load()));
        updateConfigListenerMap.put("RelatedQuery", () -> Integer.toString(ComponentUtil.getRelatedQueryHelper().load()));

            // ignore SPNEGO token for now ...
        }

        return bufferIndex - start;
    }

    @Override
    public String toString() {
        return ("SmbComNegotiateResponse[" + super.toString() + ",wordCount=" + wordCount + ",dialectIndex=" + dialectIndex
                + ",securityMode=0x" + Hexdump.toHexString(server.securityMode, 1) + ",security="

        assertEquals(0x12345678, contextWithFlags.getFlags());
    }

    @Test
    @DisplayName("Test toString representation")
    public void testToString() {
        String str = context.toString();
        assertNotNull(str);
        assertTrue(str.contains("CompressionNegotiateContext"));
        assertTrue(str.contains("LZ77"));

             * in logging output. Logging of andx segments of messages inadvertantly
             * print header information because of the way toString always makes a
             * super.toString() call(see toString() at the end of all smbs classes).
             */

            this.andx.uid = this.uid;
            dstIndex += ((AndXServerMessageBlock) this.andx).writeAndXWireFormat(dst, dstIndex);