Skip to content

Minor rst fixes #688

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

Closed
wants to merge 1 commit into from
Closed

Minor rst fixes #688

wants to merge 1 commit into from

Conversation

puentesarrin
Copy link
Contributor

No description provided.

@tychoish
Copy link
Contributor

Added the missing space in the following commit. but the describe directive isn't indexed, and so needs to remain the way it is, I'm pretty sure.

54ddcfe

@tychoish tychoish closed this Feb 27, 2013
@puentesarrin
Copy link
Contributor Author

Sam, you're right! but the describe directive doesn't build perfectly.

Look:
http://docs.mongodb.org/manual/reference/user-privileges/#combined-access

... and all of the describe directives doesn't to use any prefix like :method: or :dbcommand:.

$ grep -r -F ".. describe::" ./
./source/administration/master-slave.txt:.. describe:: host
./source/administration/master-slave.txt:.. describe:: only
./source/applications/database-references.txt:.. describe:: $ref
./source/applications/database-references.txt:.. describe:: $id
./source/applications/database-references.txt:.. describe:: $db
./source/reference/method/listFiles.txt:   .. describe:: name
./source/reference/method/listFiles.txt:   .. describe:: isDirectory
./source/reference/method/listFiles.txt:   .. describe:: size
./source/reference/mongo.txt:.. describe:: mongo [--shell] [--nodb] [--norc] [--quiet] [--port <port>] [--host <host>] [--eval <JavaScript>] [-u <username>] [--username <username>] [-p <password>] [--password <password>] [--help] [-h] [--version] [--verbose] [--ipv6] [database] [file.js]
./source/reference/mongostat.txt:.. describe:: inserts
./source/reference/mongostat.txt:.. describe:: query
./source/reference/mongostat.txt:.. describe:: update
./source/reference/mongostat.txt:.. describe:: delete
./source/reference/mongostat.txt:.. describe:: getmore
./source/reference/mongostat.txt:.. describe:: command
./source/reference/mongostat.txt:.. describe:: flushes
./source/reference/mongostat.txt:.. describe:: mapped
./source/reference/mongostat.txt:.. describe:: size
./source/reference/mongostat.txt:.. describe:: res
./source/reference/mongostat.txt:.. describe:: faults
./source/reference/mongostat.txt:.. describe:: locked
./source/reference/mongostat.txt:.. describe:: locked db
./source/reference/mongostat.txt:.. describe:: idx miss
./source/reference/mongostat.txt:.. describe:: qr
./source/reference/mongostat.txt:.. describe:: qw
./source/reference/mongostat.txt:.. describe:: ar
./source/reference/mongostat.txt:.. describe:: aw
./source/reference/mongostat.txt:.. describe:: netIn
./source/reference/mongostat.txt:.. describe:: netOut
./source/reference/mongostat.txt:.. describe:: conn
./source/reference/mongostat.txt:.. describe:: set
./source/reference/mongostat.txt:.. describe:: repl
./source/reference/system-collections.txt:.. describe:: <database>.system.users
./source/reference/user-privileges.txt:.. describe:: :method:`sh.status()`
./source/reference/user-privileges.txt:.. describe:: :dbcommand:`applyOps`, :dbcommand:`eval`, and :method:`db.eval()`

What do you think about this?

@tychoish
Copy link
Contributor

I'm ok with it in this case.

Though I think I'm going to remove the line from the mongo file, because that's awful.

@puentesarrin
Copy link
Contributor Author

What about the bad build/renderization?

user-privileges

@tychoish
Copy link
Contributor

I think the following is the best solution to this, though it's kind of silly that describe doesn't work here..

afad63e

@puentesarrin
Copy link
Contributor Author

Cool, thanks for response.

mongo-cr-bot pushed a commit that referenced this pull request Feb 25, 2022
* DOCSP-21019-revert-time-series-and-indexes-updates

* DOCSP-21019-revert-time-series-and-indexes-updates

Co-authored-by: jason-price-mongodb <[email protected]>
mongodb-server-docs-sync-bot bot pushed a commit that referenced this pull request May 22, 2025
* DOCSP-48525-disaster-recovery-faq-entry

* wording

* build error

* reviewer request

* add important

* monospace

* reviewer updates

* render issue

(cherry picked from commit 9036320)
mongodb-server-docs-sync-bot bot pushed a commit that referenced this pull request Jun 9, 2025
* DOCSP-44714-compass-ref-prefix-replacements (#688)

* DOCSP-44714-compass-ref-prefix-replacements

* *

* build errors

* typo

* DOCSP-44850-compass-prefix-updates (#692)
mongodb-server-docs-sync-bot bot pushed a commit that referenced this pull request Jun 23, 2025
* (DOCSP-42975) Unnested 2 examples in table.

* (DOCSP-42975) Wording.

* @sarahsimpers Fix punctuation

Co-authored-by: Sarah Simpers <[email protected]>

---------

Co-authored-by: Elyse Foreman <[email protected]>
Co-authored-by: Sarah Simpers <[email protected]>
(cherry picked from commit ce5d220)
mongodb-server-docs-sync-bot bot pushed a commit that referenced this pull request Jun 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants