Skip to content

Storage classes should not be described as middleware #1428

Closed
@JonathanFingold

Description

@JonathanFingold

Version

What package version of the SDK are you using. Main branch

Describe the bug

The Sphinx comments (used to generate the ref docs) describe the CosmosDbPartitionedStorage class as middleware. The term middleware has a specific meaning within the Bot Framework, and this is not it. I double checked with @stevengum to make sure I wasn't missing something (JavaScript has a similar bug, but just in 2 deprecated classes).

To Reproduce

Steps to reproduce the behavior:

  1. Look at the """ comments in cosmosdb_partitioned_storage.py:
  2. Error: storage classes are not middleware (cannot be used as middleware in a middleware set) and should not be described as such.

Expected behavior

The reference documentation should not confuse concepts in this way.

Additional context

These comments also appear in the obsolete CosmosDbStorage class.

Metadata

Metadata

Assignees

Labels

Area: DocsDocumentation issue (missing needs updates, etc.)Size: SThe issue is simple and well understood, it will take a day or less to completebugIndicates an unexpected problem or an unintended behavior.

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions