Takayuki Shimizukawa avatar Takayuki Shimizukawa committed 15524a0

adjust code-comment to suitable reST format

Comments (0)

Files changed (1)

sphinx/environment.py

             app.emit('doctree-read', doctree)
 
         # store time of build, for outdated files detection
-        # note::
-        #  Some filesystem's have coarse timestamp resolution.
-        #  Therefore time.time() is older than filesystem's timestamp.
-        #  ex. FAT32 have 2sec resolution.
+        #
+        # .. note::
+        #
+        #    Some filesystem's have coarse timestamp resolution.
+        #    Therefore time.time() is older than filesystem's timestamp.
+        #    ex. FAT32 have 2sec resolution.
         self.all_docs[docname] = max(
                 time.time(), path.getmtime(self.doc2path(docname)))
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.