Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add IntelliSense on Common Methods and Objects #184

Open
Turnerj opened this issue Oct 14, 2020 · 0 comments
Open

Add IntelliSense on Common Methods and Objects #184

Turnerj opened this issue Oct 14, 2020 · 0 comments
Labels
documentation Documentation-related issue enhancement Enhancements & features
Milestone

Comments

@Turnerj
Copy link
Member

Turnerj commented Oct 14, 2020

This is primarily for types that the user has a high chance of directly interacting with. When a concrete type has an interface, the comments should be on the interface. Visual Studio can pull the IntelliSense summary up through to the concrete type automatically. Any IntelliSense comments on concrete types already can be removed once corresponding ones are added to the interfaces.

The following types, along with their properties and methods, should have IntelliSense added:

  • IMongoDbConnection
  • IMongoDbContext / IMongoDbTenantContext
  • IMongoDbSet / IMongoDbBucketSet / IMongoDbTenantSet
  • MongoDbUtility
  • IHaveTenantId
  • BucketSetOptionsAttribute
  • DbSetOptionsAttribute
  • ExtraElementsAttribute
  • IgnoreExtraElementsAttribute
  • IndexAttribute (along with IndexType and IndexSortOrder enums)
  • RuntimeTypeDiscoveryAttribute
  • EntityEntryContainer
  • EntityEntry
  • LinqExtensions
  • QueryableAsyncExtensions

The reason for not doing the other infrastructure classes is that the core of MongoFramework is still unstable and could easily have the IntelliSense comments needing to be rewritten multiple times. The ones listed above would benefit the most people using the system.

@Turnerj Turnerj added enhancement Enhancements & features documentation Documentation-related issue labels Oct 14, 2020
@Turnerj Turnerj added this to the 1.0.0 milestone Oct 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation-related issue enhancement Enhancements & features
Projects
None yet
Development

No branches or pull requests

1 participant