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.

Sign up for GitHub

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

Jump to bottom

Improve embedded package documentation #3537

Merged
merged 3 commits into from
Oct 11, 2023
Merged

Improve embedded package documentation #3537

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
05ecfff
Improve embedded ferretdb package documentation
princejha95 Oct 7, 2023
83f00b1
Modified link to method in comment
princejha95 Oct 11, 2023
1227b26
Merge branch 'main' into doc_improve
princejha95 Oct 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions ferretdb/ferretdb.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,10 @@ func New(config *Config) (*FerretDB, error) {
// Run runs FerretDB until ctx is canceled.
//
// When this method returns, listener and all connections, as well as handler are closed.
//
// It is required to run this method in order to initialise the listeners with their respective
// IP address and port. Calling methods which require the listener's address (eg: [*FerretDB.MongoDBURI]
// requires it for configuring its Host URL) before calling this method might result in a deadlock.
func (f *FerretDB) Run(ctx context.Context) error {
err := f.l.Run(ctx)
if errors.Is(err, context.Canceled) {
Expand Down
Loading